diff --git a/app/config/specs/open-api3-1.8.x-client.json b/app/config/specs/open-api3-1.8.x-client.json index 8f03738786..58917b543a 100644 --- a/app/config/specs/open-api3-1.8.x-client.json +++ b/app/config/specs/open-api3-1.8.x-client.json @@ -4361,7 +4361,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -4446,7 +4446,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -4457,7 +4457,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -4467,7 +4466,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -4492,6 +4490,30 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Admin": [], + "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#databasesCreateCollection) API or directly from your database console." } ], "auth": { @@ -4589,7 +4611,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -4663,14 +4685,14 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "tags": [ "databases" ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "content": { "application\/json": { @@ -4684,7 +4706,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -4700,6 +4722,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -4793,7 +4834,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -4892,7 +4933,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -4953,43 +4994,42 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", "tags": [ - "databases" + "tables" ], - "description": "Decrement a specific attribute of a document by a given value.", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "Document", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/rowList" } } } } }, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 116, + "method": "listRows", + "group": "rows", + "weight": 413, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/decrement-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5016,31 +5056,151 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" }, "in": "path" } @@ -5051,15 +5211,31 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", - "x-example": null + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "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 + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } } } } @@ -5068,43 +5244,42 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", "tags": [ - "databases" + "tables" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", "responses": { "200": { - "description": "Document", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/row" } } } } }, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 115, + "method": "getRow", + "group": "rows", + "weight": 406, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/increment-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5131,31 +5306,136 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "rowId", + "description": "Row ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -5166,21 +5446,205 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "x-example": null + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{}" }, - "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 + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } } } } } } } + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] } }, "\/functions\/{functionId}\/executions": { @@ -5206,7 +5670,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -5281,7 +5745,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -5396,7 +5860,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -5470,7 +5934,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -5522,7 +5986,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -5574,7 +6038,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -5626,7 +6090,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -5678,7 +6142,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -5730,7 +6194,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -5782,7 +6246,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -5834,7 +6298,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -5886,7 +6350,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -5938,7 +6402,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -5990,7 +6454,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -6073,7 +6537,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -6148,7 +6612,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -6234,7 +6698,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -6332,7 +6796,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -6404,7 +6868,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -6493,7 +6957,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -6560,7 +7024,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -6638,7 +7102,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -6866,7 +7330,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -6951,7 +7415,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -7027,7 +7491,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -7112,7 +7576,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -7174,7 +7638,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -7248,7 +7712,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -7312,7 +7776,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -7398,7 +7862,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -7509,7 +7973,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -7581,7 +8045,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -7668,7 +8132,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -7742,7 +8206,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -7840,7 +8304,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -7901,7 +8365,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -8070,13 +8534,37 @@ "version" ] }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "$ref": "#\/components\/schemas\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8100,7 +8588,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8124,7 +8612,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8148,7 +8636,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8172,7 +8660,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8196,7 +8684,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8220,7 +8708,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8244,7 +8732,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8268,7 +8756,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8292,7 +8780,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8316,7 +8804,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8340,7 +8828,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8364,7 +8852,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8388,7 +8876,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8406,6 +8894,63 @@ "localeCodes" ] }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", diff --git a/app/config/specs/open-api3-1.8.x-console.json b/app/config/specs/open-api3-1.8.x-console.json index 85ef1334d4..77b8b42436 100644 --- a/app/config/specs/open-api3-1.8.x-console.json +++ b/app/config/specs/open-api3-1.8.x-console.json @@ -4359,7 +4359,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 310, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -4419,7 +4419,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 434, + "weight": 481, "cookies": false, "type": "", "deprecated": false, @@ -4494,7 +4494,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 309, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -4542,7 +4542,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4615,7 +4615,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4674,7 +4674,7 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesListUsages", "tags": [ "databases" ], @@ -4692,13 +4692,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "listUsages", "group": null, - "weight": 121, + "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/list-usages.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -4720,7 +4720,7 @@ "parameters": [ { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "schema": { "type": "string", @@ -4730,12 +4730,8 @@ "30d", "90d" ], - "x-enum-name": "DatabaseUsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], + "x-enum-name": null, + "x-enum-keys": [], "default": "30d" }, "in": "query" @@ -4766,7 +4762,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4825,7 +4821,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -4901,7 +4897,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -4962,7 +4958,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -5024,7 +5020,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "tags": [ "databases" @@ -5045,7 +5041,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -5149,7 +5145,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -5218,7 +5214,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -5317,7 +5313,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -5388,7 +5384,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -5425,7 +5421,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5472,7 +5468,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -5509,7 +5505,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -5578,7 +5574,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5615,7 +5611,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5689,7 +5685,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5726,7 +5722,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5774,7 +5770,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "tags": [ "databases" @@ -5795,7 +5791,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5832,7 +5828,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5906,7 +5902,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5943,7 +5939,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6012,7 +6008,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -6049,7 +6045,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6086,7 +6082,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6107,7 +6103,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -6123,12 +6119,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -6160,7 +6156,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6182,7 +6178,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "x-example": null, "items": { "type": "string" @@ -6238,7 +6234,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -6275,7 +6271,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6301,7 +6297,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "x-example": null, "items": { "type": "string" @@ -6320,7 +6316,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6358,7 +6354,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -6395,7 +6391,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6422,17 +6418,17 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null }, "array": { @@ -6474,7 +6470,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -6511,7 +6507,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6542,23 +6538,23 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6595,7 +6591,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6632,7 +6628,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6659,17 +6655,17 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6711,7 +6707,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6748,7 +6744,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6779,23 +6775,23 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6832,7 +6828,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -6869,7 +6865,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6896,7 +6892,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6938,7 +6934,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -6975,7 +6971,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7006,13 +7002,13 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7049,7 +7045,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -7086,7 +7082,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7103,7 +7099,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "x-example": "" }, "type": { @@ -7180,7 +7176,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -7217,7 +7213,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -7297,7 +7293,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -7334,7 +7330,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -7376,7 +7372,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7413,7 +7409,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -7450,7 +7446,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7519,7 +7515,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7556,7 +7552,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7593,7 +7589,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7661,7 +7657,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7698,7 +7694,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7732,7 +7728,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7769,7 +7765,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7812,7 +7808,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7849,7 +7845,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7887,7 +7883,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } } @@ -7920,7 +7916,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -8005,7 +8001,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -8016,7 +8012,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -8026,7 +8021,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -8156,7 +8150,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "content": { "application\/json": { @@ -8170,7 +8164,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -8185,6 +8179,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [] } @@ -8262,7 +8274,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -8356,7 +8368,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -8447,7 +8459,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8521,14 +8533,14 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "tags": [ "databases" ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "content": { "application\/json": { @@ -8542,7 +8554,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8558,6 +8570,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -8651,7 +8682,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8750,7 +8781,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8834,7 +8865,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 112, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -8927,7 +8958,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -8939,8 +8970,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8951,8 +8980,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9004,7 +9032,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "x-example": null }, "min": { @@ -9042,7 +9070,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -9054,8 +9082,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -9066,8 +9092,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9157,7 +9182,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -9238,8 +9263,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -9367,7 +9392,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -9438,7 +9463,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -9518,7 +9543,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 79, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -9601,7 +9626,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 123, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -9693,7 +9718,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 73, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -9743,10 +9768,4763 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/tableList" + } + } + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, rowSecurity", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnList" + } + } + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + } + } + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndexList" + } + } + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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": "tablesDeleteIndex", + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/logs": { + "get": { + "summary": "List table logs", + "operationId": "databasesListTableLogs", + "tags": [ + "databases" + ], + "description": "Get the table activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } + } + }, + "x-appwrite": { + "method": "listTableLogs", + "group": "tables", + "weight": 376, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/list-table-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + } + } + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + } + } + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { + "get": { + "summary": "List row logs", + "operationId": "tablesListRowLogs", + "tags": [ + "tables" + ], + "description": "Get the row activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } + } + }, + "x-appwrite": { + "method": "listRowLogs", + "group": "logs", + "weight": 414, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-row-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { + "get": { + "summary": "Get table usage stats", + "operationId": "tablesGetTableUsage", + "tags": [ + "tables" + ], + "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageTable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageTable" + } + } + } + } + }, + "x-appwrite": { + "method": "getTableUsage", + "group": null, + "weight": 377, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-table-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "30d" + }, + "in": "query" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetDatabaseUsage", + "operationId": "databasesGetUsage", "tags": [ "databases" ], @@ -9764,13 +14542,13 @@ } }, "x-appwrite": { - "method": "getDatabaseUsage", + "method": "getUsage", "group": null, - "weight": 122, + "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-database-usage.md", + "demo": "databases\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -9802,7 +14580,7 @@ }, { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "schema": { "type": "string", @@ -9848,7 +14626,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9921,7 +14699,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -10154,7 +14932,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -10203,7 +14981,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -10253,7 +15031,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 404, + "weight": 451, "cookies": false, "type": "", "deprecated": false, @@ -10353,7 +15131,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 403, + "weight": 450, "cookies": false, "type": "", "deprecated": false, @@ -10413,7 +15191,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 397, + "weight": 444, "cookies": false, "type": "", "deprecated": false, @@ -10485,7 +15263,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -10544,7 +15322,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -10774,7 +15552,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -10835,7 +15613,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -10915,7 +15693,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -10998,7 +15776,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -11094,7 +15872,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -11179,7 +15957,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -11282,7 +16060,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -11379,7 +16157,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -11441,7 +16219,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -11505,7 +16283,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -11595,7 +16373,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -11666,7 +16444,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -11741,7 +16519,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -11856,7 +16634,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -11921,7 +16699,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -11992,7 +16770,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 396, + "weight": 443, "cookies": false, "type": "", "deprecated": false, @@ -12074,7 +16852,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -12133,7 +16911,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -12224,7 +17002,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -12293,7 +17071,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -12384,7 +17162,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -12455,7 +17233,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -12507,7 +17285,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -12559,7 +17337,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -12608,7 +17386,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -12657,7 +17435,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -12706,7 +17484,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -12766,7 +17544,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -12815,7 +17593,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -12864,7 +17642,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -12926,7 +17704,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -12988,7 +17766,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -13061,7 +17839,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -13123,7 +17901,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -13211,7 +17989,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -13273,7 +18051,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -13335,7 +18113,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -13397,7 +18175,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -13459,7 +18237,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -13521,7 +18299,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -13583,7 +18361,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -13645,7 +18423,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -13707,7 +18485,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -13756,7 +18534,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -13805,7 +18583,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -13854,7 +18632,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -13906,7 +18684,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -13958,7 +18736,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -14010,7 +18788,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -14062,7 +18840,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -14114,7 +18892,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -14166,7 +18944,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -14218,7 +18996,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -14270,7 +19048,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -14346,7 +19124,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -14490,7 +19268,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -14636,7 +19414,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -14810,7 +19588,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -14988,7 +19766,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -15097,7 +19875,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -15209,7 +19987,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -15262,7 +20040,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -15324,7 +20102,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -15399,7 +20177,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -15474,7 +20252,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -15550,7 +20328,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -15655,7 +20433,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -15763,7 +20541,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -15848,7 +20626,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -15936,7 +20714,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -16051,7 +20829,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -16169,7 +20947,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -16264,7 +21042,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -16362,7 +21140,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -16467,7 +21245,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -16575,7 +21353,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -16718,7 +21496,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -16863,7 +21641,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -16958,7 +21736,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -17056,7 +21834,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -17151,7 +21929,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -17249,7 +22027,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -17344,7 +22122,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -17442,7 +22220,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -17537,7 +22315,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -17635,7 +22413,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -17688,7 +22466,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -17750,7 +22528,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -17825,7 +22603,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -17900,7 +22678,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -17974,7 +22752,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -18057,7 +22835,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -18117,7 +22895,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -18194,7 +22972,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -18256,7 +23034,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -18331,7 +23109,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -18415,7 +23193,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -18505,7 +23283,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -18568,7 +23346,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -18643,7 +23421,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 316, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -18717,7 +23495,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 311, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -18805,7 +23583,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 318, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -18898,7 +23676,7 @@ "x-appwrite": { "method": "createCsvMigration", "group": null, - "weight": 315, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -18977,7 +23755,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 312, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -19053,7 +23831,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 319, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -19125,7 +23903,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 314, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -19236,7 +24014,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 321, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -19369,7 +24147,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 313, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -19474,7 +24252,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 320, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -19598,7 +24376,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 317, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -19656,7 +24434,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 322, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -19707,7 +24485,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 323, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -19767,7 +24545,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 202, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -19855,7 +24633,7 @@ "x-appwrite": { "method": "listVariables", "group": null, - "weight": 204, + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -19901,7 +24679,7 @@ "x-appwrite": { "method": "createVariable", "group": null, - "weight": 203, + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -19979,7 +24757,7 @@ "x-appwrite": { "method": "getVariable", "group": null, - "weight": 205, + "weight": 152, "cookies": false, "type": "", "deprecated": false, @@ -20037,7 +24815,7 @@ "x-appwrite": { "method": "updateVariable", "group": null, - "weight": 206, + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -20117,7 +24895,7 @@ "x-appwrite": { "method": "deleteVariable", "group": null, - "weight": 207, + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -20177,7 +24955,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 157, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -20249,7 +25027,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 156, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -20383,7 +25161,7 @@ "x-appwrite": { "method": "get", "group": "projects", - "weight": 158, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -20441,7 +25219,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 159, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -20556,7 +25334,7 @@ "x-appwrite": { "method": "delete", "group": "projects", - "weight": 176, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -20616,7 +25394,7 @@ "x-appwrite": { "method": "updateApiStatus", "group": "projects", - "weight": 163, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -20708,7 +25486,7 @@ "x-appwrite": { "method": "updateApiStatusAll", "group": "projects", - "weight": 164, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -20787,7 +25565,7 @@ "x-appwrite": { "method": "updateAuthDuration", "group": "auth", - "weight": 169, + "weight": 115, "cookies": false, "type": "", "deprecated": false, @@ -20866,7 +25644,7 @@ "x-appwrite": { "method": "updateAuthLimit", "group": "auth", - "weight": 168, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -20945,7 +25723,7 @@ "x-appwrite": { "method": "updateAuthSessionsLimit", "group": "auth", - "weight": 174, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -21024,7 +25802,7 @@ "x-appwrite": { "method": "updateMembershipsPrivacy", "group": "auth", - "weight": 167, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -21115,7 +25893,7 @@ "x-appwrite": { "method": "updateMockNumbers", "group": "auth", - "weight": 175, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -21197,7 +25975,7 @@ "x-appwrite": { "method": "updateAuthPasswordDictionary", "group": "auth", - "weight": 172, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -21276,7 +26054,7 @@ "x-appwrite": { "method": "updateAuthPasswordHistory", "group": "auth", - "weight": 171, + "weight": 117, "cookies": false, "type": "", "deprecated": false, @@ -21355,7 +26133,7 @@ "x-appwrite": { "method": "updatePersonalDataCheck", "group": "auth", - "weight": 173, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -21434,7 +26212,7 @@ "x-appwrite": { "method": "updateSessionAlerts", "group": "auth", - "weight": 166, + "weight": 112, "cookies": false, "type": "", "deprecated": false, @@ -21490,6 +26268,85 @@ } } }, + "\/projects\/{projectId}\/auth\/session-invalidation": { + "patch": { + "summary": "Update invalidate session option of the project", + "operationId": "projectsUpdateSessionInvalidation", + "tags": [ + "projects" + ], + "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "x-appwrite": { + "method": "updateSessionInvalidation", + "group": "auth", + "weight": 148, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-session-invalidation.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, "\/projects\/{projectId}\/auth\/{method}": { "patch": { "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", @@ -21513,7 +26370,7 @@ "x-appwrite": { "method": "updateAuthStatus", "group": "auth", - "weight": 170, + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -21613,7 +26470,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 373, + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -21681,7 +26538,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 370, + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -21766,7 +26623,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 372, + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -21834,7 +26691,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 371, + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -21920,7 +26777,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 374, + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -21990,7 +26847,7 @@ "x-appwrite": { "method": "createJWT", "group": "auth", - "weight": 188, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -22077,7 +26934,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 184, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -22135,7 +26992,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 183, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -22228,7 +27085,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 185, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -22296,7 +27153,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 186, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -22390,7 +27247,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 187, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -22460,7 +27317,7 @@ "x-appwrite": { "method": "updateOAuth2", "group": "auth", - "weight": 165, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -22598,7 +27455,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 190, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -22656,7 +27513,7 @@ "x-appwrite": { "method": "createPlatform", "group": "platforms", - "weight": 189, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -22775,7 +27632,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 191, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -22843,7 +27700,7 @@ "x-appwrite": { "method": "updatePlatform", "group": "platforms", - "weight": 192, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -22938,7 +27795,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 193, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -23008,7 +27865,7 @@ "x-appwrite": { "method": "updateServiceStatus", "group": "projects", - "weight": 161, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -23109,7 +27966,7 @@ "x-appwrite": { "method": "updateServiceStatusAll", "group": "projects", - "weight": 162, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -23188,7 +28045,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 194, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -23306,7 +28163,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 195, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -23437,7 +28294,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 160, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -23516,7 +28373,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 197, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -23740,7 +28597,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 199, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -24004,7 +28861,7 @@ "x-appwrite": { "method": "deleteEmailTemplate", "group": "templates", - "weight": 201, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -24230,7 +29087,7 @@ "x-appwrite": { "method": "getSmsTemplate", "group": "templates", - "weight": 196, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -24451,7 +29308,7 @@ "x-appwrite": { "method": "updateSmsTemplate", "group": "templates", - "weight": 198, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -24691,7 +29548,7 @@ "x-appwrite": { "method": "deleteSmsTemplate", "group": "templates", - "weight": 200, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -24914,7 +29771,7 @@ "x-appwrite": { "method": "listWebhooks", "group": "webhooks", - "weight": 178, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -24972,7 +29829,7 @@ "x-appwrite": { "method": "createWebhook", "group": "webhooks", - "weight": 177, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -25087,7 +29944,7 @@ "x-appwrite": { "method": "getWebhook", "group": "webhooks", - "weight": 179, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -25155,7 +30012,7 @@ "x-appwrite": { "method": "updateWebhook", "group": "webhooks", - "weight": 180, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -25271,7 +30128,7 @@ "x-appwrite": { "method": "deleteWebhook", "group": "webhooks", - "weight": 182, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -25341,7 +30198,7 @@ "x-appwrite": { "method": "updateWebhookSignature", "group": "webhooks", - "weight": 181, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -25411,7 +30268,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 294, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -25485,7 +30342,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 435, + "weight": 482, "cookies": false, "type": "", "deprecated": false, @@ -25552,7 +30409,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 437, + "weight": 484, "cookies": false, "type": "", "deprecated": false, @@ -25630,7 +30487,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 438, + "weight": 485, "cookies": false, "type": "", "deprecated": false, @@ -25743,7 +30600,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 436, + "weight": 483, "cookies": false, "type": "", "deprecated": false, @@ -25821,7 +30678,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 295, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -25872,7 +30729,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 296, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -25932,7 +30789,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 297, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -25992,7 +30849,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -26062,7 +30919,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -26311,7 +31168,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -26360,7 +31217,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -26410,7 +31267,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 429, + "weight": 476, "cookies": false, "type": "", "deprecated": false, @@ -26510,7 +31367,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 430, + "weight": 477, "cookies": false, "type": "", "deprecated": false, @@ -26570,7 +31427,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 431, + "weight": 478, "cookies": false, "type": "", "deprecated": false, @@ -26642,7 +31499,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -26701,7 +31558,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -26946,7 +31803,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -27007,7 +31864,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -27087,7 +31944,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -27170,7 +32027,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -27271,7 +32128,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -27351,7 +32208,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -27454,7 +32311,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -27552,7 +32409,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -27614,7 +32471,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -27678,7 +32535,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -27768,7 +32625,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -27839,7 +32696,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -27910,7 +32767,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -27972,7 +32829,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -28043,7 +32900,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 432, + "weight": 479, "cookies": false, "type": "", "deprecated": false, @@ -28125,7 +32982,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -28184,7 +33041,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -28275,7 +33132,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -28344,7 +33201,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -28435,7 +33292,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -28506,7 +33363,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -28579,7 +33436,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -28706,7 +33563,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -28765,7 +33622,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -28889,7 +33746,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -28950,7 +33807,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -29036,7 +33893,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -29134,7 +33991,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -29206,7 +34063,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -29295,7 +34152,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -29362,7 +34219,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -29440,7 +34297,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -29668,7 +34525,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -29753,7 +34610,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 222, + "weight": 169, "cookies": false, "type": "", "deprecated": false, @@ -29825,7 +34682,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 223, + "weight": 170, "cookies": false, "type": "", "deprecated": false, @@ -29907,7 +34764,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -29983,7 +34840,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -30068,7 +34925,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -30130,7 +34987,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -30204,7 +35061,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -30268,7 +35125,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 237, + "weight": 184, "cookies": false, "type": "", "deprecated": false, @@ -30341,7 +35198,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -30427,7 +35284,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -30538,7 +35395,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -30610,7 +35467,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -30697,7 +35554,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -30771,7 +35628,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -30868,7 +35725,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -30928,7 +35785,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -31009,7 +35866,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -31089,7 +35946,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -31178,7 +36035,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -31238,7 +36095,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -31308,7 +36165,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -31370,7 +36227,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -31443,7 +36300,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -31531,7 +36388,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -31616,7 +36473,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -31701,7 +36558,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -31769,7 +36626,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -31830,7 +36687,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -31915,7 +36772,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -32000,7 +36857,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -32115,7 +36972,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -32218,7 +37075,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -32323,7 +37180,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 280, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -32395,7 +37252,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -32447,7 +37304,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -32508,7 +37365,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -32588,7 +37445,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -32670,7 +37527,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -32753,7 +37610,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -32827,7 +37684,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -32912,7 +37769,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -32985,7 +37842,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -33061,7 +37918,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -33122,7 +37979,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -33181,7 +38038,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -33240,7 +38097,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -33301,7 +38158,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -33381,7 +38238,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -33461,7 +38318,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -33541,7 +38398,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -33600,7 +38457,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -33680,7 +38537,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -33739,7 +38596,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -33791,7 +38648,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -33845,7 +38702,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -33916,7 +38773,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -33996,7 +38853,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -34069,7 +38926,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -34179,7 +39036,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -34249,7 +39106,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -34338,7 +39195,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -34410,7 +39267,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -34492,7 +39349,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -34572,7 +39429,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -34652,7 +39509,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 284, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -34748,7 +39605,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 285, + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -34833,7 +39690,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 286, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -34918,7 +39775,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 287, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -34988,7 +39845,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 288, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -35058,7 +39915,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 283, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -35112,6 +39969,17 @@ "default": "" }, "in": "query" + }, + { + "name": "providerReference", + "description": "Git reference (branch, tag, commit) to get contents from", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -35132,7 +40000,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 293, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -35221,7 +40089,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 290, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -35295,7 +40163,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 291, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -35346,7 +40214,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 292, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -35493,13 +40361,37 @@ "version" ] }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "$ref": "#\/components\/schemas\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35517,13 +40409,37 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "$ref": "#\/components\/schemas\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35547,7 +40463,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35571,7 +40487,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35589,13 +40505,37 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35619,7 +40559,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35643,7 +40583,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35667,7 +40607,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35691,7 +40631,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35715,7 +40655,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35739,7 +40679,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35763,7 +40703,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35787,7 +40727,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35811,7 +40751,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35835,7 +40775,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35859,7 +40799,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35883,7 +40823,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35907,7 +40847,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of installations documents that matched your query.", + "description": "Total number of installations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35931,7 +40871,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworkProviderRepositories documents that matched your query.", + "description": "Total number of frameworkProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35955,7 +40895,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimeProviderRepositories documents that matched your query.", + "description": "Total number of runtimeProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35979,7 +40919,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of branches documents that matched your query.", + "description": "Total number of branches rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36003,7 +40943,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36027,7 +40967,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36051,7 +40991,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36075,7 +41015,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36099,7 +41039,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of projects documents that matched your query.", + "description": "Total number of projects rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36123,7 +41063,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of webhooks documents that matched your query.", + "description": "Total number of webhooks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36147,7 +41087,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of keys documents that matched your query.", + "description": "Total number of keys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36171,7 +41111,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of devKeys documents that matched your query.", + "description": "Total number of devKeys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36195,7 +41135,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of platforms documents that matched your query.", + "description": "Total number of platforms rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36219,7 +41159,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36243,7 +41183,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36267,7 +41207,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36291,7 +41231,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36315,7 +41255,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36339,7 +41279,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36363,7 +41303,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of rules documents that matched your query.", + "description": "Total number of rules rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36387,7 +41327,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36411,7 +41351,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36435,7 +41375,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36459,7 +41399,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36483,7 +41423,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36507,7 +41447,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36531,7 +41471,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of migrations documents that matched your query.", + "description": "Total number of migrations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36555,7 +41495,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36579,7 +41519,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of contents documents that matched your query.", + "description": "Total number of contents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -37532,6 +42472,903 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -37604,6 +43441,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", @@ -40500,6 +46466,11 @@ "description": "Whether or not to show user MFA status in the teams membership response.", "x-example": true }, + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true + }, "oAuthProviders": { "type": "array", "description": "List of Auth Providers.", @@ -40721,6 +46692,7 @@ "authMembershipsUserName", "authMembershipsUserEmail", "authMembershipsMfa", + "authInvalidateSessions", "oAuthProviders", "platforms", "webhooks", @@ -40793,7 +46765,10 @@ "items": { "type": "string" }, - "x-example": "database.collections.update" + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] }, "security": { "type": "boolean", @@ -41512,12 +47487,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total databases storage in bytes.", @@ -41552,6 +47539,14 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41560,6 +47555,14 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "An array of the aggregated number of databases storage in bytes per period.", @@ -41589,13 +47592,17 @@ "range", "databasesTotal", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databasesReadsTotal", "databasesWritesTotal", "databases", "collections", + "tables", "documents", + "rows", "storage", "databasesReads", "databasesWrites" @@ -41616,12 +47623,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total storage used in bytes.", @@ -41648,6 +47667,14 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41656,6 +47683,14 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "Aggregated storage used in bytes per period.", @@ -41684,17 +47719,51 @@ "required": [ "range", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databaseReadsTotal", "databaseWritesTotal", "collections", + "tables", "documents", + "rows", "storage", "databaseReads", "databaseWrites" ] }, + "usageTable": { + "description": "UsageTable", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of of rows.", + "x-example": 0, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "rowsTotal", + "rows" + ] + }, "usageCollection": { "description": "UsageCollection", "type": "object", @@ -42813,6 +48882,12 @@ "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "databasesTotal": { "type": "integer", "description": "Total aggregated number of databases.", @@ -43019,6 +49094,7 @@ "required": [ "executionsTotal", "documentsTotal", + "rowsTotal", "databasesTotal", "databasesStorageTotal", "usersTotal", diff --git a/app/config/specs/open-api3-1.8.x-server.json b/app/config/specs/open-api3-1.8.x-server.json index 3e9b87fdf1..a4e905fda7 100644 --- a/app/config/specs/open-api3-1.8.x-server.json +++ b/app/config/specs/open-api3-1.8.x-server.json @@ -4060,7 +4060,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4134,7 +4134,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4214,7 +4214,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4274,7 +4274,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -4351,7 +4351,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -4413,7 +4413,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -4476,7 +4476,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "tags": [ "databases" @@ -4497,7 +4497,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -4602,7 +4602,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -4672,7 +4672,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -4772,7 +4772,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -4844,7 +4844,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -4882,7 +4882,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -4929,7 +4929,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -4967,7 +4967,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -5036,7 +5036,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5074,7 +5074,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5148,7 +5148,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5186,7 +5186,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5234,7 +5234,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "tags": [ "databases" @@ -5255,7 +5255,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5293,7 +5293,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5367,7 +5367,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5405,7 +5405,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5474,7 +5474,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -5512,7 +5512,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5549,7 +5549,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -5570,7 +5570,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -5586,12 +5586,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5624,7 +5624,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5646,7 +5646,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "x-example": null, "items": { "type": "string" @@ -5702,7 +5702,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -5740,7 +5740,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5766,7 +5766,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "x-example": null, "items": { "type": "string" @@ -5785,7 +5785,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -5823,7 +5823,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -5861,7 +5861,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5888,17 +5888,17 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null }, "array": { @@ -5940,7 +5940,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -5978,7 +5978,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6009,23 +6009,23 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6062,7 +6062,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6100,7 +6100,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6127,17 +6127,17 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6179,7 +6179,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6217,7 +6217,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6248,23 +6248,23 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6301,7 +6301,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -6339,7 +6339,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6366,7 +6366,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6408,7 +6408,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -6446,7 +6446,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6477,13 +6477,13 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6520,7 +6520,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -6558,7 +6558,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6575,7 +6575,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "x-example": "" }, "type": { @@ -6652,7 +6652,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -6690,7 +6690,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -6770,7 +6770,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -6808,7 +6808,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -6850,7 +6850,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6887,7 +6887,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -6925,7 +6925,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6994,7 +6994,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7032,7 +7032,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7069,7 +7069,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7137,7 +7137,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7175,7 +7175,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7209,7 +7209,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7247,7 +7247,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7290,7 +7290,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7328,7 +7328,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7366,7 +7366,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } } @@ -7399,7 +7399,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -7486,7 +7486,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -7497,7 +7497,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -7507,7 +7506,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -7639,7 +7637,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "content": { "application\/json": { @@ -7653,7 +7651,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -7668,6 +7666,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [], "Key": [] @@ -7746,7 +7762,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -7841,7 +7857,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -7933,7 +7949,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8009,14 +8025,14 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "tags": [ "databases" ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "content": { "application\/json": { @@ -8030,7 +8046,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8046,6 +8062,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [], "Session": [] @@ -8141,7 +8176,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8242,7 +8277,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8328,7 +8363,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -8340,8 +8375,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8353,9 +8386,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8407,7 +8438,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "x-example": null }, "min": { @@ -8445,7 +8476,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -8457,8 +8488,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8470,9 +8499,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8562,7 +8589,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -8644,8 +8671,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -8774,7 +8801,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -8846,7 +8873,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -8904,6 +8931,4544 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/tableList" + } + } + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, rowSecurity", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnList" + } + } + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + } + } + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndexList" + } + } + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table 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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table 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": "tablesDeleteIndex", + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + } + } + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + } + } + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, "\/functions": { "get": { "summary": "List functions", @@ -8927,7 +13492,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9001,7 +13566,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -9235,7 +13800,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -9285,7 +13850,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -9336,7 +13901,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -9396,7 +13961,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -9627,7 +14192,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -9689,7 +14254,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -9770,7 +14335,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -9854,7 +14419,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -9951,7 +14516,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -10037,7 +14602,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -10141,7 +14706,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -10239,7 +14804,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -10302,7 +14867,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -10367,7 +14932,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -10458,7 +15023,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -10530,7 +15095,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -10607,7 +15172,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -10724,7 +15289,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -10791,7 +15356,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -10863,7 +15428,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -10923,7 +15488,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -11015,7 +15580,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -11085,7 +15650,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -11177,7 +15742,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -11249,7 +15814,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -11303,7 +15868,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -11357,7 +15922,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -11407,7 +15972,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -11457,7 +16022,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -11507,7 +16072,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -11568,7 +16133,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -11618,7 +16183,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -11668,7 +16233,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -11731,7 +16296,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -11794,7 +16359,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -11868,7 +16433,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -11931,7 +16496,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -12020,7 +16585,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -12083,7 +16648,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -12146,7 +16711,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -12209,7 +16774,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -12272,7 +16837,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -12335,7 +16900,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -12398,7 +16963,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -12461,7 +17026,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -12524,7 +17089,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -12574,7 +17139,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -12624,7 +17189,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -12674,7 +17239,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -12728,7 +17293,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -12782,7 +17347,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -12836,7 +17401,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -12890,7 +17455,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -12944,7 +17509,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -12998,7 +17563,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -13052,7 +17617,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -13106,7 +17671,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -13183,7 +17748,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -13328,7 +17893,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -13475,7 +18040,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -13650,7 +18215,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -13829,7 +18394,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -13939,7 +18504,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -14052,7 +18617,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -14106,7 +18671,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -14169,7 +18734,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -14245,7 +18810,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -14321,7 +18886,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -14398,7 +18963,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -14504,7 +19069,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -14613,7 +19178,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -14699,7 +19264,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -14788,7 +19353,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -14904,7 +19469,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -15023,7 +19588,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -15119,7 +19684,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -15218,7 +19783,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -15324,7 +19889,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -15433,7 +19998,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -15577,7 +20142,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -15723,7 +20288,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -15819,7 +20384,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -15918,7 +20483,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -16014,7 +20579,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -16113,7 +20678,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -16209,7 +20774,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -16308,7 +20873,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -16404,7 +20969,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -16503,7 +21068,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -16557,7 +21122,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -16620,7 +21185,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -16696,7 +21261,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -16772,7 +21337,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -16847,7 +21412,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -16931,7 +21496,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -16992,7 +21557,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -17070,7 +21635,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -17133,7 +21698,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -17209,7 +21774,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -17294,7 +21859,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -17386,7 +21951,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -17450,7 +22015,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -17527,7 +22092,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -17598,7 +22163,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -17848,7 +22413,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -17898,7 +22463,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -17949,7 +22514,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -18009,7 +22574,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -18255,7 +22820,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -18317,7 +22882,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -18398,7 +22963,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -18482,7 +23047,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -18584,7 +23149,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -18665,7 +23230,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -18769,7 +23334,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -18868,7 +23433,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -18931,7 +23496,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -18996,7 +23561,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -19087,7 +23652,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -19159,7 +23724,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -19231,7 +23796,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -19294,7 +23859,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -19366,7 +23931,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -19426,7 +23991,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -19518,7 +24083,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -19588,7 +24153,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -19680,7 +24245,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -19752,7 +24317,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -19826,7 +24391,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -19954,7 +24519,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -20014,7 +24579,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -20139,7 +24704,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -20201,7 +24766,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -20289,7 +24854,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -20389,7 +24954,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -20463,7 +25028,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -20554,7 +25119,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -20623,7 +25188,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -20703,7 +25268,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -20933,7 +25498,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -21020,7 +25585,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -21098,7 +25663,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -21185,7 +25750,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -21249,7 +25814,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -21325,7 +25890,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -21391,7 +25956,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -21479,7 +26044,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -21592,7 +26157,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -21666,7 +26231,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -21755,7 +26320,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -21831,7 +26396,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -21930,7 +26495,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -21992,7 +26557,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -22075,7 +26640,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -22156,7 +26721,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -22246,7 +26811,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -22307,7 +26872,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -22378,7 +26943,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -22441,7 +27006,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22515,7 +27080,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -22604,7 +27169,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -22690,7 +27255,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -22776,7 +27341,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -22845,7 +27410,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -22907,7 +27472,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -22993,7 +27558,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -23079,7 +27644,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -23195,7 +27760,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -23299,7 +27864,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -23405,7 +27970,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23458,7 +28023,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -23520,7 +28085,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -23601,7 +28166,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -23684,7 +28249,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -23768,7 +28333,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -23843,7 +28408,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -23929,7 +28494,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -24003,7 +28568,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -24080,7 +28645,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -24142,7 +28707,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -24202,7 +28767,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -24262,7 +28827,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -24324,7 +28889,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -24405,7 +28970,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -24486,7 +29051,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -24567,7 +29132,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -24627,7 +29192,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -24708,7 +29273,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -24768,7 +29333,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -24821,7 +29386,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -24876,7 +29441,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -24948,7 +29513,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -25029,7 +29594,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -25103,7 +29668,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -25214,7 +29779,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -25285,7 +29850,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -25375,7 +29940,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -25448,7 +30013,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -25531,7 +30096,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -25612,7 +30177,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -25780,13 +30345,37 @@ "version" ] }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "$ref": "#\/components\/schemas\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25804,13 +30393,37 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "$ref": "#\/components\/schemas\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25834,7 +30447,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25858,7 +30471,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25876,13 +30489,37 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25906,7 +30543,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25930,7 +30567,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25954,7 +30591,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25978,7 +30615,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26002,7 +30639,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26026,7 +30663,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26050,7 +30687,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26074,7 +30711,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26098,7 +30735,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26122,7 +30759,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26146,7 +30783,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26170,7 +30807,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26194,7 +30831,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26218,7 +30855,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26242,7 +30879,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26266,7 +30903,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26290,7 +30927,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26314,7 +30951,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26338,7 +30975,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26362,7 +30999,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26386,7 +31023,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26410,7 +31047,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26434,7 +31071,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26458,7 +31095,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26482,7 +31119,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26506,7 +31143,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26530,7 +31167,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -27483,6 +32120,903 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -27555,6 +33089,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", diff --git a/app/config/specs/open-api3-latest-client.json b/app/config/specs/open-api3-latest-client.json index 73a027f4bb..58917b543a 100644 --- a/app/config/specs/open-api3-latest-client.json +++ b/app/config/specs/open-api3-latest-client.json @@ -4361,7 +4361,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -4446,7 +4446,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -4457,7 +4457,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -4467,7 +4466,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -4496,6 +4494,7 @@ { "name": "createDocuments", "auth": { + "Admin": [], "Key": [] }, "parameters": [ @@ -4612,7 +4611,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -4686,14 +4685,14 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "tags": [ "databases" ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "content": { "application\/json": { @@ -4707,7 +4706,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -4723,6 +4722,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -4816,7 +4834,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -4915,7 +4933,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -4976,43 +4994,42 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", "tags": [ - "databases" + "tables" ], - "description": "Decrement a specific attribute of a document by a given value.", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "Document", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/rowList" } } } } }, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 116, + "method": "listRows", + "group": "rows", + "weight": 413, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/decrement-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5039,31 +5056,151 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" }, "in": "path" } @@ -5074,15 +5211,31 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", - "x-example": null + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "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 + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } } } } @@ -5091,43 +5244,42 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", "tags": [ - "databases" + "tables" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", "responses": { "200": { - "description": "Document", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/row" } } } } }, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 115, + "method": "getRow", + "group": "rows", + "weight": 406, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/increment-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5154,31 +5306,136 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "rowId", + "description": "Row ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -5189,21 +5446,205 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "x-example": null + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{}" }, - "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 + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } } } } } } } + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] } }, "\/functions\/{functionId}\/executions": { @@ -5229,7 +5670,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -5304,7 +5745,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -5419,7 +5860,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -5493,7 +5934,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -5545,7 +5986,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -5597,7 +6038,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -5649,7 +6090,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -5701,7 +6142,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -5753,7 +6194,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -5805,7 +6246,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -5857,7 +6298,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -5909,7 +6350,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -5961,7 +6402,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -6013,7 +6454,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -6096,7 +6537,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -6171,7 +6612,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -6257,7 +6698,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -6355,7 +6796,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -6427,7 +6868,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -6516,7 +6957,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -6583,7 +7024,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -6661,7 +7102,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -6889,7 +7330,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -6974,7 +7415,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -7050,7 +7491,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -7135,7 +7576,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -7197,7 +7638,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -7271,7 +7712,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -7335,7 +7776,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -7421,7 +7862,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -7532,7 +7973,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -7604,7 +8045,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -7691,7 +8132,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -7765,7 +8206,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -7863,7 +8304,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -7924,7 +8365,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -8093,13 +8534,37 @@ "version" ] }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "$ref": "#\/components\/schemas\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8123,7 +8588,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8147,7 +8612,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8171,7 +8636,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8195,7 +8660,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8219,7 +8684,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8243,7 +8708,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8267,7 +8732,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8291,7 +8756,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8315,7 +8780,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8339,7 +8804,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8363,7 +8828,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8387,7 +8852,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8411,7 +8876,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8429,6 +8894,63 @@ "localeCodes" ] }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", diff --git a/app/config/specs/open-api3-latest-console.json b/app/config/specs/open-api3-latest-console.json index 92ba5c6829..77b8b42436 100644 --- a/app/config/specs/open-api3-latest-console.json +++ b/app/config/specs/open-api3-latest-console.json @@ -4359,7 +4359,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 310, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -4419,7 +4419,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 434, + "weight": 481, "cookies": false, "type": "", "deprecated": false, @@ -4494,7 +4494,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 309, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -4542,7 +4542,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4615,7 +4615,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4674,7 +4674,7 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesListUsages", "tags": [ "databases" ], @@ -4692,13 +4692,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "listUsages", "group": null, - "weight": 121, + "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/list-usages.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -4720,7 +4720,7 @@ "parameters": [ { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "schema": { "type": "string", @@ -4730,12 +4730,8 @@ "30d", "90d" ], - "x-enum-name": "DatabaseUsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], + "x-enum-name": null, + "x-enum-keys": [], "default": "30d" }, "in": "query" @@ -4766,7 +4762,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4825,7 +4821,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -4901,7 +4897,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -4962,7 +4958,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -5024,7 +5020,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "tags": [ "databases" @@ -5045,7 +5041,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -5149,7 +5145,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -5218,7 +5214,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -5317,7 +5313,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -5388,7 +5384,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -5425,7 +5421,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5472,7 +5468,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -5509,7 +5505,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -5578,7 +5574,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5615,7 +5611,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5689,7 +5685,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5726,7 +5722,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5774,7 +5770,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "tags": [ "databases" @@ -5795,7 +5791,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5832,7 +5828,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5906,7 +5902,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5943,7 +5939,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6012,7 +6008,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -6049,7 +6045,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6086,7 +6082,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6107,7 +6103,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -6123,12 +6119,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -6160,7 +6156,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6182,7 +6178,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "x-example": null, "items": { "type": "string" @@ -6238,7 +6234,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -6275,7 +6271,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6301,7 +6297,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "x-example": null, "items": { "type": "string" @@ -6320,7 +6316,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6358,7 +6354,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -6395,7 +6391,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6422,17 +6418,17 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null }, "array": { @@ -6474,7 +6470,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -6511,7 +6507,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6542,23 +6538,23 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6595,7 +6591,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6632,7 +6628,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6659,17 +6655,17 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6711,7 +6707,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6748,7 +6744,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6779,23 +6775,23 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6832,7 +6828,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -6869,7 +6865,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6896,7 +6892,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6938,7 +6934,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -6975,7 +6971,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7006,13 +7002,13 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7049,7 +7045,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -7086,7 +7082,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7103,7 +7099,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "x-example": "" }, "type": { @@ -7180,7 +7176,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -7217,7 +7213,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -7297,7 +7293,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -7334,7 +7330,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -7376,7 +7372,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7413,7 +7409,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -7450,7 +7446,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7519,7 +7515,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7556,7 +7552,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7593,7 +7589,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7661,7 +7657,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7698,7 +7694,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7732,7 +7728,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7769,7 +7765,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7812,7 +7808,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7849,7 +7845,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7887,7 +7883,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } } @@ -7920,7 +7916,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -8005,7 +8001,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -8016,7 +8012,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -8026,7 +8021,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -8156,7 +8150,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "content": { "application\/json": { @@ -8170,7 +8164,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -8185,6 +8179,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [] } @@ -8262,7 +8274,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -8356,7 +8368,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -8447,7 +8459,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8521,14 +8533,14 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "tags": [ "databases" ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "content": { "application\/json": { @@ -8542,7 +8554,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8558,6 +8570,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -8651,7 +8682,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8750,7 +8781,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8834,7 +8865,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 112, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -8927,7 +8958,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -8939,8 +8970,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8951,8 +8980,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9004,7 +9032,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "x-example": null }, "min": { @@ -9042,7 +9070,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -9054,8 +9082,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -9066,8 +9092,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9157,7 +9182,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -9238,8 +9263,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -9367,7 +9392,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -9438,7 +9463,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -9518,7 +9543,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 79, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -9601,7 +9626,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 123, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -9693,7 +9718,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 73, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -9743,10 +9768,4763 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/tableList" + } + } + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, rowSecurity", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnList" + } + } + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + } + } + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndexList" + } + } + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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": "tablesDeleteIndex", + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/logs": { + "get": { + "summary": "List table logs", + "operationId": "databasesListTableLogs", + "tags": [ + "databases" + ], + "description": "Get the table activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } + } + }, + "x-appwrite": { + "method": "listTableLogs", + "group": "tables", + "weight": 376, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/list-table-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + } + } + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + } + } + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { + "get": { + "summary": "List row logs", + "operationId": "tablesListRowLogs", + "tags": [ + "tables" + ], + "description": "Get the row activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } + } + }, + "x-appwrite": { + "method": "listRowLogs", + "group": "logs", + "weight": 414, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-row-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { + "get": { + "summary": "Get table usage stats", + "operationId": "tablesGetTableUsage", + "tags": [ + "tables" + ], + "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageTable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageTable" + } + } + } + } + }, + "x-appwrite": { + "method": "getTableUsage", + "group": null, + "weight": 377, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-table-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "30d" + }, + "in": "query" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetDatabaseUsage", + "operationId": "databasesGetUsage", "tags": [ "databases" ], @@ -9764,13 +14542,13 @@ } }, "x-appwrite": { - "method": "getDatabaseUsage", + "method": "getUsage", "group": null, - "weight": 122, + "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-database-usage.md", + "demo": "databases\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -9802,7 +14580,7 @@ }, { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "schema": { "type": "string", @@ -9848,7 +14626,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9921,7 +14699,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -10154,7 +14932,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -10203,7 +14981,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -10253,7 +15031,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 404, + "weight": 451, "cookies": false, "type": "", "deprecated": false, @@ -10353,7 +15131,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 403, + "weight": 450, "cookies": false, "type": "", "deprecated": false, @@ -10413,7 +15191,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 397, + "weight": 444, "cookies": false, "type": "", "deprecated": false, @@ -10485,7 +15263,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -10544,7 +15322,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -10774,7 +15552,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -10835,7 +15613,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -10915,7 +15693,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -10998,7 +15776,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -11094,7 +15872,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -11179,7 +15957,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -11282,7 +16060,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -11379,7 +16157,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -11441,7 +16219,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -11505,7 +16283,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -11595,7 +16373,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -11666,7 +16444,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -11741,7 +16519,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -11856,7 +16634,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -11921,7 +16699,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -11992,7 +16770,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 396, + "weight": 443, "cookies": false, "type": "", "deprecated": false, @@ -12074,7 +16852,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -12133,7 +16911,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -12224,7 +17002,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -12293,7 +17071,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -12384,7 +17162,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -12455,7 +17233,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -12507,7 +17285,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -12559,7 +17337,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -12608,7 +17386,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -12657,7 +17435,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -12706,7 +17484,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -12766,7 +17544,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -12815,7 +17593,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -12864,7 +17642,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -12926,7 +17704,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -12988,7 +17766,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -13061,7 +17839,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -13123,7 +17901,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -13211,7 +17989,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -13273,7 +18051,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -13335,7 +18113,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -13397,7 +18175,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -13459,7 +18237,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -13521,7 +18299,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -13583,7 +18361,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -13645,7 +18423,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -13707,7 +18485,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -13756,7 +18534,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -13805,7 +18583,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -13854,7 +18632,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -13906,7 +18684,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -13958,7 +18736,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -14010,7 +18788,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -14062,7 +18840,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -14114,7 +18892,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -14166,7 +18944,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -14218,7 +18996,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -14270,7 +19048,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -14346,7 +19124,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -14490,7 +19268,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -14636,7 +19414,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -14810,7 +19588,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -14988,7 +19766,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -15097,7 +19875,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -15209,7 +19987,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -15262,7 +20040,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -15324,7 +20102,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -15399,7 +20177,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -15474,7 +20252,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -15550,7 +20328,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -15655,7 +20433,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -15763,7 +20541,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -15848,7 +20626,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -15936,7 +20714,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -16051,7 +20829,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -16169,7 +20947,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -16264,7 +21042,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -16362,7 +21140,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -16467,7 +21245,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -16575,7 +21353,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -16718,7 +21496,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -16863,7 +21641,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -16958,7 +21736,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -17056,7 +21834,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -17151,7 +21929,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -17249,7 +22027,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -17344,7 +22122,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -17442,7 +22220,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -17537,7 +22315,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -17635,7 +22413,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -17688,7 +22466,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -17750,7 +22528,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -17825,7 +22603,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -17900,7 +22678,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -17974,7 +22752,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -18057,7 +22835,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -18117,7 +22895,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -18194,7 +22972,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -18256,7 +23034,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -18331,7 +23109,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -18415,7 +23193,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -18505,7 +23283,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -18568,7 +23346,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -18643,7 +23421,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 316, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -18717,7 +23495,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 311, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -18805,7 +23583,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 318, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -18898,7 +23676,7 @@ "x-appwrite": { "method": "createCsvMigration", "group": null, - "weight": 315, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -18977,7 +23755,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 312, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -19053,7 +23831,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 319, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -19125,7 +23903,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 314, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -19236,7 +24014,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 321, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -19369,7 +24147,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 313, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -19474,7 +24252,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 320, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -19598,7 +24376,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 317, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -19656,7 +24434,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 322, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -19707,7 +24485,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 323, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -19767,7 +24545,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 202, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -19855,7 +24633,7 @@ "x-appwrite": { "method": "listVariables", "group": null, - "weight": 204, + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -19901,7 +24679,7 @@ "x-appwrite": { "method": "createVariable", "group": null, - "weight": 203, + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -19979,7 +24757,7 @@ "x-appwrite": { "method": "getVariable", "group": null, - "weight": 205, + "weight": 152, "cookies": false, "type": "", "deprecated": false, @@ -20037,7 +24815,7 @@ "x-appwrite": { "method": "updateVariable", "group": null, - "weight": 206, + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -20117,7 +24895,7 @@ "x-appwrite": { "method": "deleteVariable", "group": null, - "weight": 207, + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -20177,7 +24955,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 157, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -20249,7 +25027,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 156, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -20383,7 +25161,7 @@ "x-appwrite": { "method": "get", "group": "projects", - "weight": 158, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -20441,7 +25219,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 159, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -20556,7 +25334,7 @@ "x-appwrite": { "method": "delete", "group": "projects", - "weight": 176, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -20616,7 +25394,7 @@ "x-appwrite": { "method": "updateApiStatus", "group": "projects", - "weight": 163, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -20708,7 +25486,7 @@ "x-appwrite": { "method": "updateApiStatusAll", "group": "projects", - "weight": 164, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -20787,7 +25565,7 @@ "x-appwrite": { "method": "updateAuthDuration", "group": "auth", - "weight": 169, + "weight": 115, "cookies": false, "type": "", "deprecated": false, @@ -20866,7 +25644,7 @@ "x-appwrite": { "method": "updateAuthLimit", "group": "auth", - "weight": 168, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -20945,7 +25723,7 @@ "x-appwrite": { "method": "updateAuthSessionsLimit", "group": "auth", - "weight": 174, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -21024,7 +25802,7 @@ "x-appwrite": { "method": "updateMembershipsPrivacy", "group": "auth", - "weight": 167, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -21115,7 +25893,7 @@ "x-appwrite": { "method": "updateMockNumbers", "group": "auth", - "weight": 175, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -21197,7 +25975,7 @@ "x-appwrite": { "method": "updateAuthPasswordDictionary", "group": "auth", - "weight": 172, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -21276,7 +26054,7 @@ "x-appwrite": { "method": "updateAuthPasswordHistory", "group": "auth", - "weight": 171, + "weight": 117, "cookies": false, "type": "", "deprecated": false, @@ -21355,7 +26133,7 @@ "x-appwrite": { "method": "updatePersonalDataCheck", "group": "auth", - "weight": 173, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -21434,7 +26212,7 @@ "x-appwrite": { "method": "updateSessionAlerts", "group": "auth", - "weight": 166, + "weight": 112, "cookies": false, "type": "", "deprecated": false, @@ -21490,6 +26268,85 @@ } } }, + "\/projects\/{projectId}\/auth\/session-invalidation": { + "patch": { + "summary": "Update invalidate session option of the project", + "operationId": "projectsUpdateSessionInvalidation", + "tags": [ + "projects" + ], + "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "x-appwrite": { + "method": "updateSessionInvalidation", + "group": "auth", + "weight": 148, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-session-invalidation.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, "\/projects\/{projectId}\/auth\/{method}": { "patch": { "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", @@ -21513,7 +26370,7 @@ "x-appwrite": { "method": "updateAuthStatus", "group": "auth", - "weight": 170, + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -21613,7 +26470,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 373, + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -21681,7 +26538,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 370, + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -21766,7 +26623,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 372, + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -21834,7 +26691,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 371, + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -21920,7 +26777,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 374, + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -21990,7 +26847,7 @@ "x-appwrite": { "method": "createJWT", "group": "auth", - "weight": 188, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -22077,7 +26934,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 184, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -22135,7 +26992,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 183, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -22228,7 +27085,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 185, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -22296,7 +27153,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 186, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -22390,7 +27247,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 187, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -22460,7 +27317,7 @@ "x-appwrite": { "method": "updateOAuth2", "group": "auth", - "weight": 165, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -22598,7 +27455,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 190, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -22656,7 +27513,7 @@ "x-appwrite": { "method": "createPlatform", "group": "platforms", - "weight": 189, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -22775,7 +27632,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 191, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -22843,7 +27700,7 @@ "x-appwrite": { "method": "updatePlatform", "group": "platforms", - "weight": 192, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -22938,7 +27795,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 193, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -23008,7 +27865,7 @@ "x-appwrite": { "method": "updateServiceStatus", "group": "projects", - "weight": 161, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -23109,7 +27966,7 @@ "x-appwrite": { "method": "updateServiceStatusAll", "group": "projects", - "weight": 162, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -23188,7 +28045,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 194, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -23306,7 +28163,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 195, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -23437,7 +28294,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 160, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -23516,7 +28373,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 197, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -23740,7 +28597,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 199, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -24004,7 +28861,7 @@ "x-appwrite": { "method": "deleteEmailTemplate", "group": "templates", - "weight": 201, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -24230,7 +29087,7 @@ "x-appwrite": { "method": "getSmsTemplate", "group": "templates", - "weight": 196, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -24451,7 +29308,7 @@ "x-appwrite": { "method": "updateSmsTemplate", "group": "templates", - "weight": 198, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -24691,7 +29548,7 @@ "x-appwrite": { "method": "deleteSmsTemplate", "group": "templates", - "weight": 200, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -24914,7 +29771,7 @@ "x-appwrite": { "method": "listWebhooks", "group": "webhooks", - "weight": 178, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -24972,7 +29829,7 @@ "x-appwrite": { "method": "createWebhook", "group": "webhooks", - "weight": 177, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -25087,7 +29944,7 @@ "x-appwrite": { "method": "getWebhook", "group": "webhooks", - "weight": 179, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -25155,7 +30012,7 @@ "x-appwrite": { "method": "updateWebhook", "group": "webhooks", - "weight": 180, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -25271,7 +30128,7 @@ "x-appwrite": { "method": "deleteWebhook", "group": "webhooks", - "weight": 182, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -25341,7 +30198,7 @@ "x-appwrite": { "method": "updateWebhookSignature", "group": "webhooks", - "weight": 181, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -25411,7 +30268,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 294, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -25485,7 +30342,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 435, + "weight": 482, "cookies": false, "type": "", "deprecated": false, @@ -25552,7 +30409,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 437, + "weight": 484, "cookies": false, "type": "", "deprecated": false, @@ -25630,7 +30487,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 438, + "weight": 485, "cookies": false, "type": "", "deprecated": false, @@ -25743,7 +30600,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 436, + "weight": 483, "cookies": false, "type": "", "deprecated": false, @@ -25821,7 +30678,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 295, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -25872,7 +30729,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 296, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -25932,7 +30789,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 297, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -25992,7 +30849,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -26062,7 +30919,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -26311,7 +31168,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -26360,7 +31217,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -26410,7 +31267,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 429, + "weight": 476, "cookies": false, "type": "", "deprecated": false, @@ -26510,7 +31367,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 430, + "weight": 477, "cookies": false, "type": "", "deprecated": false, @@ -26570,7 +31427,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 431, + "weight": 478, "cookies": false, "type": "", "deprecated": false, @@ -26642,7 +31499,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -26701,7 +31558,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -26946,7 +31803,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -27007,7 +31864,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -27087,7 +31944,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -27170,7 +32027,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -27271,7 +32128,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -27351,7 +32208,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -27454,7 +32311,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -27552,7 +32409,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -27614,7 +32471,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -27678,7 +32535,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -27768,7 +32625,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -27839,7 +32696,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -27910,7 +32767,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -27972,7 +32829,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -28043,7 +32900,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 432, + "weight": 479, "cookies": false, "type": "", "deprecated": false, @@ -28125,7 +32982,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -28184,7 +33041,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -28275,7 +33132,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -28344,7 +33201,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -28435,7 +33292,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -28506,7 +33363,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -28579,7 +33436,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -28706,7 +33563,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -28765,7 +33622,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -28889,7 +33746,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -28950,7 +33807,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -29036,7 +33893,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -29134,7 +33991,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -29206,7 +34063,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -29295,7 +34152,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -29362,7 +34219,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -29440,7 +34297,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -29668,7 +34525,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -29753,7 +34610,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 222, + "weight": 169, "cookies": false, "type": "", "deprecated": false, @@ -29825,7 +34682,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 223, + "weight": 170, "cookies": false, "type": "", "deprecated": false, @@ -29907,7 +34764,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -29983,7 +34840,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -30068,7 +34925,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -30130,7 +34987,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -30204,7 +35061,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -30268,7 +35125,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 237, + "weight": 184, "cookies": false, "type": "", "deprecated": false, @@ -30341,7 +35198,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -30427,7 +35284,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -30538,7 +35395,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -30610,7 +35467,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -30697,7 +35554,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -30771,7 +35628,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -30868,7 +35725,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -30928,7 +35785,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -31009,7 +35866,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -31089,7 +35946,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -31178,7 +36035,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -31238,7 +36095,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -31308,7 +36165,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -31370,7 +36227,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -31443,7 +36300,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -31531,7 +36388,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -31616,7 +36473,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -31701,7 +36558,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -31769,7 +36626,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -31830,7 +36687,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -31915,7 +36772,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -32000,7 +36857,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -32115,7 +36972,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -32218,7 +37075,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -32323,7 +37180,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 280, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -32395,7 +37252,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -32447,7 +37304,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -32508,7 +37365,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -32588,7 +37445,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -32670,7 +37527,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -32753,7 +37610,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -32827,7 +37684,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -32912,7 +37769,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -32985,7 +37842,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -33061,7 +37918,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -33122,7 +37979,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -33181,7 +38038,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -33240,7 +38097,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -33301,7 +38158,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -33381,7 +38238,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -33461,7 +38318,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -33541,7 +38398,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -33600,7 +38457,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -33680,7 +38537,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -33739,7 +38596,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -33791,7 +38648,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -33845,7 +38702,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -33916,7 +38773,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -33996,7 +38853,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -34069,7 +38926,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -34179,7 +39036,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -34249,7 +39106,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -34338,7 +39195,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -34410,7 +39267,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -34492,7 +39349,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -34572,7 +39429,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -34652,7 +39509,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 284, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -34748,7 +39605,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 285, + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -34833,7 +39690,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 286, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -34918,7 +39775,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 287, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -34988,7 +39845,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 288, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -35058,7 +39915,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 283, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -35143,7 +40000,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 293, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -35232,7 +40089,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 290, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -35306,7 +40163,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 291, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -35357,7 +40214,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 292, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -35504,13 +40361,37 @@ "version" ] }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "$ref": "#\/components\/schemas\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35528,13 +40409,37 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "$ref": "#\/components\/schemas\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35558,7 +40463,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35582,7 +40487,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35600,13 +40505,37 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35630,7 +40559,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35654,7 +40583,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35678,7 +40607,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35702,7 +40631,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35726,7 +40655,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35750,7 +40679,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35774,7 +40703,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35798,7 +40727,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35822,7 +40751,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35846,7 +40775,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35870,7 +40799,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35894,7 +40823,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35918,7 +40847,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of installations documents that matched your query.", + "description": "Total number of installations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35942,7 +40871,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworkProviderRepositories documents that matched your query.", + "description": "Total number of frameworkProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35966,7 +40895,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimeProviderRepositories documents that matched your query.", + "description": "Total number of runtimeProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35990,7 +40919,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of branches documents that matched your query.", + "description": "Total number of branches rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36014,7 +40943,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36038,7 +40967,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36062,7 +40991,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36086,7 +41015,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36110,7 +41039,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of projects documents that matched your query.", + "description": "Total number of projects rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36134,7 +41063,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of webhooks documents that matched your query.", + "description": "Total number of webhooks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36158,7 +41087,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of keys documents that matched your query.", + "description": "Total number of keys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36182,7 +41111,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of devKeys documents that matched your query.", + "description": "Total number of devKeys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36206,7 +41135,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of platforms documents that matched your query.", + "description": "Total number of platforms rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36230,7 +41159,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36254,7 +41183,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36278,7 +41207,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36302,7 +41231,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36326,7 +41255,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36350,7 +41279,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36374,7 +41303,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of rules documents that matched your query.", + "description": "Total number of rules rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36398,7 +41327,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36422,7 +41351,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36446,7 +41375,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36470,7 +41399,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36494,7 +41423,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36518,7 +41447,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36542,7 +41471,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of migrations documents that matched your query.", + "description": "Total number of migrations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36566,7 +41495,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36590,7 +41519,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of contents documents that matched your query.", + "description": "Total number of contents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -37543,6 +42472,903 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -37615,6 +43441,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", @@ -40511,6 +46466,11 @@ "description": "Whether or not to show user MFA status in the teams membership response.", "x-example": true }, + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true + }, "oAuthProviders": { "type": "array", "description": "List of Auth Providers.", @@ -40732,6 +46692,7 @@ "authMembershipsUserName", "authMembershipsUserEmail", "authMembershipsMfa", + "authInvalidateSessions", "oAuthProviders", "platforms", "webhooks", @@ -40804,7 +46765,10 @@ "items": { "type": "string" }, - "x-example": "database.collections.update" + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] }, "security": { "type": "boolean", @@ -41523,12 +47487,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total databases storage in bytes.", @@ -41563,6 +47539,14 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41571,6 +47555,14 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "An array of the aggregated number of databases storage in bytes per period.", @@ -41600,13 +47592,17 @@ "range", "databasesTotal", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databasesReadsTotal", "databasesWritesTotal", "databases", "collections", + "tables", "documents", + "rows", "storage", "databasesReads", "databasesWrites" @@ -41627,12 +47623,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total storage used in bytes.", @@ -41659,6 +47667,14 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41667,6 +47683,14 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "Aggregated storage used in bytes per period.", @@ -41695,17 +47719,51 @@ "required": [ "range", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databaseReadsTotal", "databaseWritesTotal", "collections", + "tables", "documents", + "rows", "storage", "databaseReads", "databaseWrites" ] }, + "usageTable": { + "description": "UsageTable", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of of rows.", + "x-example": 0, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "rowsTotal", + "rows" + ] + }, "usageCollection": { "description": "UsageCollection", "type": "object", @@ -42824,6 +48882,12 @@ "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "databasesTotal": { "type": "integer", "description": "Total aggregated number of databases.", @@ -43030,6 +49094,7 @@ "required": [ "executionsTotal", "documentsTotal", + "rowsTotal", "databasesTotal", "databasesStorageTotal", "usersTotal", diff --git a/app/config/specs/open-api3-latest-server.json b/app/config/specs/open-api3-latest-server.json index 3e9b87fdf1..a4e905fda7 100644 --- a/app/config/specs/open-api3-latest-server.json +++ b/app/config/specs/open-api3-latest-server.json @@ -4060,7 +4060,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4134,7 +4134,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4214,7 +4214,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4274,7 +4274,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -4351,7 +4351,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -4413,7 +4413,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -4476,7 +4476,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "tags": [ "databases" @@ -4497,7 +4497,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -4602,7 +4602,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -4672,7 +4672,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -4772,7 +4772,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -4844,7 +4844,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -4882,7 +4882,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -4929,7 +4929,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -4967,7 +4967,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -5036,7 +5036,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5074,7 +5074,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5148,7 +5148,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5186,7 +5186,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -5234,7 +5234,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "tags": [ "databases" @@ -5255,7 +5255,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5293,7 +5293,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5367,7 +5367,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5405,7 +5405,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5474,7 +5474,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -5512,7 +5512,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5549,7 +5549,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -5570,7 +5570,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -5586,12 +5586,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5624,7 +5624,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5646,7 +5646,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "x-example": null, "items": { "type": "string" @@ -5702,7 +5702,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -5740,7 +5740,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5766,7 +5766,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "x-example": null, "items": { "type": "string" @@ -5785,7 +5785,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -5823,7 +5823,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -5861,7 +5861,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -5888,17 +5888,17 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null }, "array": { @@ -5940,7 +5940,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -5978,7 +5978,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6009,23 +6009,23 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6062,7 +6062,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6100,7 +6100,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6127,17 +6127,17 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6179,7 +6179,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6217,7 +6217,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6248,23 +6248,23 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6301,7 +6301,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -6339,7 +6339,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6366,7 +6366,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null }, "array": { @@ -6408,7 +6408,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -6446,7 +6446,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6477,13 +6477,13 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6520,7 +6520,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -6558,7 +6558,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6575,7 +6575,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "x-example": "" }, "type": { @@ -6652,7 +6652,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -6690,7 +6690,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -6770,7 +6770,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -6808,7 +6808,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -6850,7 +6850,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -6887,7 +6887,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -6925,7 +6925,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -6994,7 +6994,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7032,7 +7032,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7069,7 +7069,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } }, @@ -7137,7 +7137,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7175,7 +7175,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7209,7 +7209,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7247,7 +7247,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7290,7 +7290,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7328,7 +7328,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -7366,7 +7366,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null } } @@ -7399,7 +7399,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -7486,7 +7486,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -7497,7 +7497,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -7507,7 +7506,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -7639,7 +7637,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "content": { "application\/json": { @@ -7653,7 +7651,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -7668,6 +7666,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [], "Key": [] @@ -7746,7 +7762,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -7841,7 +7857,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -7933,7 +7949,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8009,14 +8025,14 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "tags": [ "databases" ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "content": { "application\/json": { @@ -8030,7 +8046,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8046,6 +8062,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [], "Session": [] @@ -8141,7 +8176,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8242,7 +8277,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8328,7 +8363,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -8340,8 +8375,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8353,9 +8386,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8407,7 +8438,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "x-example": null }, "min": { @@ -8445,7 +8476,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -8457,8 +8488,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8470,9 +8499,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8562,7 +8589,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -8644,8 +8671,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -8774,7 +8801,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -8846,7 +8873,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -8904,6 +8931,4544 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/tableList" + } + } + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, rowSecurity", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnList" + } + } + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBoolean" + } + } + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEmail" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnEnum" + } + } + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnInteger" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnUrl" + } + } + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + } + } + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnRelationship" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndexList" + } + } + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table 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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIndex" + } + } + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table 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": "tablesDeleteIndex", + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + } + } + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + } + } + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" + } + } + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "x-example": null + } + } + } + } + } + } + } + }, "\/functions": { "get": { "summary": "List functions", @@ -8927,7 +13492,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9001,7 +13566,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -9235,7 +13800,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -9285,7 +13850,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -9336,7 +13901,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -9396,7 +13961,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -9627,7 +14192,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -9689,7 +14254,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -9770,7 +14335,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -9854,7 +14419,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -9951,7 +14516,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -10037,7 +14602,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -10141,7 +14706,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -10239,7 +14804,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -10302,7 +14867,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -10367,7 +14932,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -10458,7 +15023,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -10530,7 +15095,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -10607,7 +15172,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -10724,7 +15289,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -10791,7 +15356,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -10863,7 +15428,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -10923,7 +15488,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -11015,7 +15580,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -11085,7 +15650,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -11177,7 +15742,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -11249,7 +15814,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -11303,7 +15868,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -11357,7 +15922,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -11407,7 +15972,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -11457,7 +16022,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -11507,7 +16072,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -11568,7 +16133,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -11618,7 +16183,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -11668,7 +16233,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -11731,7 +16296,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -11794,7 +16359,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -11868,7 +16433,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -11931,7 +16496,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -12020,7 +16585,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -12083,7 +16648,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -12146,7 +16711,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -12209,7 +16774,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -12272,7 +16837,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -12335,7 +16900,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -12398,7 +16963,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -12461,7 +17026,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -12524,7 +17089,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -12574,7 +17139,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -12624,7 +17189,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -12674,7 +17239,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -12728,7 +17293,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -12782,7 +17347,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -12836,7 +17401,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -12890,7 +17455,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -12944,7 +17509,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -12998,7 +17563,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -13052,7 +17617,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -13106,7 +17671,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -13183,7 +17748,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -13328,7 +17893,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -13475,7 +18040,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -13650,7 +18215,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -13829,7 +18394,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -13939,7 +18504,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -14052,7 +18617,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -14106,7 +18671,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -14169,7 +18734,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -14245,7 +18810,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -14321,7 +18886,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -14398,7 +18963,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -14504,7 +19069,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -14613,7 +19178,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -14699,7 +19264,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -14788,7 +19353,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -14904,7 +19469,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -15023,7 +19588,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -15119,7 +19684,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -15218,7 +19783,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -15324,7 +19889,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -15433,7 +19998,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -15577,7 +20142,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -15723,7 +20288,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -15819,7 +20384,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -15918,7 +20483,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -16014,7 +20579,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -16113,7 +20678,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -16209,7 +20774,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -16308,7 +20873,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -16404,7 +20969,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -16503,7 +21068,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -16557,7 +21122,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -16620,7 +21185,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -16696,7 +21261,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -16772,7 +21337,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -16847,7 +21412,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -16931,7 +21496,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -16992,7 +21557,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -17070,7 +21635,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -17133,7 +21698,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -17209,7 +21774,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -17294,7 +21859,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -17386,7 +21951,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -17450,7 +22015,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -17527,7 +22092,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -17598,7 +22163,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -17848,7 +22413,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -17898,7 +22463,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -17949,7 +22514,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -18009,7 +22574,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -18255,7 +22820,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -18317,7 +22882,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -18398,7 +22963,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -18482,7 +23047,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -18584,7 +23149,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -18665,7 +23230,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -18769,7 +23334,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -18868,7 +23433,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -18931,7 +23496,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -18996,7 +23561,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -19087,7 +23652,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -19159,7 +23724,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -19231,7 +23796,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -19294,7 +23859,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -19366,7 +23931,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -19426,7 +23991,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -19518,7 +24083,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -19588,7 +24153,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -19680,7 +24245,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -19752,7 +24317,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -19826,7 +24391,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -19954,7 +24519,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -20014,7 +24579,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -20139,7 +24704,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -20201,7 +24766,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -20289,7 +24854,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -20389,7 +24954,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -20463,7 +25028,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -20554,7 +25119,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -20623,7 +25188,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -20703,7 +25268,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -20933,7 +25498,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -21020,7 +25585,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -21098,7 +25663,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -21185,7 +25750,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -21249,7 +25814,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -21325,7 +25890,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -21391,7 +25956,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -21479,7 +26044,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -21592,7 +26157,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -21666,7 +26231,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -21755,7 +26320,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -21831,7 +26396,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -21930,7 +26495,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -21992,7 +26557,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -22075,7 +26640,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -22156,7 +26721,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -22246,7 +26811,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -22307,7 +26872,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -22378,7 +26943,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -22441,7 +27006,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22515,7 +27080,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -22604,7 +27169,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -22690,7 +27255,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -22776,7 +27341,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -22845,7 +27410,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -22907,7 +27472,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -22993,7 +27558,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -23079,7 +27644,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -23195,7 +27760,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -23299,7 +27864,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -23405,7 +27970,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23458,7 +28023,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -23520,7 +28085,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -23601,7 +28166,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -23684,7 +28249,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -23768,7 +28333,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -23843,7 +28408,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -23929,7 +28494,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -24003,7 +28568,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -24080,7 +28645,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -24142,7 +28707,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -24202,7 +28767,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -24262,7 +28827,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -24324,7 +28889,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -24405,7 +28970,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -24486,7 +29051,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -24567,7 +29132,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -24627,7 +29192,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -24708,7 +29273,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -24768,7 +29333,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -24821,7 +29386,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -24876,7 +29441,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -24948,7 +29513,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -25029,7 +29594,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -25103,7 +29668,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -25214,7 +29779,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -25285,7 +29850,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -25375,7 +29940,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -25448,7 +30013,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -25531,7 +30096,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -25612,7 +30177,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -25780,13 +30345,37 @@ "version" ] }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "$ref": "#\/components\/schemas\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25804,13 +30393,37 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "$ref": "#\/components\/schemas\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25834,7 +30447,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25858,7 +30471,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25876,13 +30489,37 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25906,7 +30543,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25930,7 +30567,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25954,7 +30591,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -25978,7 +30615,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26002,7 +30639,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26026,7 +30663,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26050,7 +30687,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26074,7 +30711,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26098,7 +30735,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26122,7 +30759,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26146,7 +30783,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26170,7 +30807,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26194,7 +30831,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26218,7 +30855,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26242,7 +30879,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26266,7 +30903,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26290,7 +30927,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26314,7 +30951,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26338,7 +30975,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26362,7 +30999,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26386,7 +31023,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26410,7 +31047,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26434,7 +31071,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26458,7 +31095,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26482,7 +31119,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26506,7 +31143,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26530,7 +31167,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -27483,6 +32120,903 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -27555,6 +33089,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", diff --git a/app/config/specs/swagger2-1.8.x-client.json b/app/config/specs/swagger2-1.8.x-client.json index 33fe1a93c9..84445b4af5 100644 --- a/app/config/specs/swagger2-1.8.x-client.json +++ b/app/config/specs/swagger2-1.8.x-client.json @@ -4510,7 +4510,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -4592,7 +4592,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -4603,7 +4603,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -4613,7 +4612,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -4638,6 +4636,30 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Admin": [], + "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#databasesCreateCollection) API or directly from your database console." } ], "auth": { @@ -4733,7 +4755,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -4800,7 +4822,7 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "consumes": [ "application\/json" @@ -4813,7 +4835,7 @@ ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -4823,7 +4845,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -4839,6 +4861,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -4928,7 +4969,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -5025,7 +5066,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -5080,45 +5121,42 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" + "tables" ], - "description": "Decrement a specific attribute of a document by a given value.", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "Document", + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/rowList" } } }, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 116, + "method": "listRows", + "group": "rows", + "weight": 413, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/decrement-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5143,26 +5181,147 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -5171,17 +5330,35 @@ "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 + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{}" + }, + "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": null + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } } } @@ -5189,45 +5366,42 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" + "tables" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", "responses": { "200": { - "description": "Document", + "description": "Row", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/row" } } }, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 115, + "method": "getRow", + "group": "rows", + "weight": 406, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/increment-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5252,26 +5426,128 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "rowId", + "description": "Row ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "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" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -5280,22 +5556,200 @@ "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 + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "default": [], + "x-example": "{}" }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "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": null + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } } } } } ] + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] } }, "\/functions\/{functionId}\/executions": { @@ -5321,7 +5775,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -5395,7 +5849,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -5512,7 +5966,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -5584,7 +6038,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -5658,7 +6112,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -5730,7 +6184,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -5782,7 +6236,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -5834,7 +6288,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -5886,7 +6340,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -5938,7 +6392,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -5990,7 +6444,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -6042,7 +6496,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -6094,7 +6548,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -6148,7 +6602,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -6233,7 +6687,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -6304,7 +6758,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -6387,7 +6841,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -6477,7 +6931,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -6547,7 +7001,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -6636,7 +7090,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -6706,7 +7160,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -6785,7 +7239,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -6992,7 +7446,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -7071,7 +7525,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -7146,7 +7600,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -7236,7 +7690,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -7298,7 +7752,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -7373,7 +7827,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -7435,7 +7889,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -7518,7 +7972,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -7631,7 +8085,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -7701,7 +8155,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -7787,7 +8241,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -7859,7 +8313,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -7953,7 +8407,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -8014,7 +8468,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -8147,13 +8601,38 @@ "type": "object", "additionalProperties": true }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "type": "object", + "$ref": "#\/definitions\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8178,7 +8657,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8203,7 +8682,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8228,7 +8707,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8253,7 +8732,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8278,7 +8757,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8303,7 +8782,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8328,7 +8807,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8353,7 +8832,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8378,7 +8857,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8403,7 +8882,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8428,7 +8907,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8453,7 +8932,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8478,7 +8957,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8497,6 +8976,63 @@ "localeCodes" ] }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", diff --git a/app/config/specs/swagger2-1.8.x-console.json b/app/config/specs/swagger2-1.8.x-console.json index a11fd21b42..4ac2c7b317 100644 --- a/app/config/specs/swagger2-1.8.x-console.json +++ b/app/config/specs/swagger2-1.8.x-console.json @@ -4527,7 +4527,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 310, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -4590,7 +4590,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 434, + "weight": 481, "cookies": false, "type": "", "deprecated": false, @@ -4661,7 +4661,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 309, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -4709,7 +4709,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4781,7 +4781,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4843,7 +4843,7 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesListUsages", "consumes": [], "produces": [ "application\/json" @@ -4861,13 +4861,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "listUsages", "group": null, - "weight": 121, + "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/list-usages.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -4889,7 +4889,7 @@ "parameters": [ { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "type": "string", "x-example": "24h", @@ -4898,12 +4898,8 @@ "30d", "90d" ], - "x-enum-name": "DatabaseUsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], + "x-enum-name": null, + "x-enum-keys": [], "default": "30d", "in": "query" } @@ -4933,7 +4929,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4992,7 +4988,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -5070,7 +5066,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -5129,7 +5125,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -5186,7 +5182,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "consumes": [ "application\/json" @@ -5209,7 +5205,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -5314,7 +5310,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -5381,7 +5377,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -5482,7 +5478,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -5549,7 +5545,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -5584,7 +5580,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5630,7 +5626,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -5665,7 +5661,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -5736,7 +5732,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5771,7 +5767,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5844,7 +5840,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5879,7 +5875,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5927,7 +5923,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "consumes": [ "application\/json" @@ -5950,7 +5946,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5985,7 +5981,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6058,7 +6054,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -6093,7 +6089,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6164,7 +6160,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -6199,7 +6195,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6233,7 +6229,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6260,7 +6256,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -6272,12 +6268,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -6307,7 +6303,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6327,7 +6323,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "default": null, "x-example": null, "items": { @@ -6388,7 +6384,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -6423,7 +6419,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6444,7 +6440,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "default": null, "x-example": null, "items": { @@ -6466,7 +6462,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6506,7 +6502,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -6541,7 +6537,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6567,19 +6563,19 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null }, @@ -6624,7 +6620,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -6659,7 +6655,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6686,26 +6682,26 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6744,7 +6740,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6779,7 +6775,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6805,19 +6801,19 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -6862,7 +6858,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6897,7 +6893,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6924,26 +6920,26 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6982,7 +6978,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -7017,7 +7013,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7043,7 +7039,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -7088,7 +7084,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -7123,7 +7119,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7150,14 +7146,14 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7196,7 +7192,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -7231,7 +7227,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7245,7 +7241,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "default": null, "x-example": "" }, @@ -7329,7 +7325,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -7364,7 +7360,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -7448,7 +7444,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -7483,7 +7479,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -7523,7 +7519,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7562,7 +7558,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -7597,7 +7593,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7668,7 +7664,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7703,7 +7699,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7737,7 +7733,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7805,7 +7801,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7840,7 +7836,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7874,7 +7870,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7909,7 +7905,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7950,7 +7946,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7985,7 +7981,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -8019,7 +8015,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -8052,7 +8048,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -8134,7 +8130,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -8145,7 +8141,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -8155,7 +8150,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -8289,7 +8283,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "schema": { "$ref": "#\/definitions\/documentList" @@ -8299,7 +8293,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -8314,6 +8308,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [] } @@ -8388,7 +8400,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -8480,7 +8492,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -8566,7 +8578,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8633,7 +8645,7 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "consumes": [ "application\/json" @@ -8646,7 +8658,7 @@ ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -8656,7 +8668,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8672,6 +8684,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -8761,7 +8792,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8858,7 +8889,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8936,7 +8967,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 112, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -9024,7 +9055,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -9036,8 +9067,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -9048,8 +9077,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9092,7 +9120,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "default": 1, "x-example": null }, @@ -9133,7 +9161,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -9145,8 +9173,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -9157,8 +9183,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9240,7 +9265,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -9318,8 +9343,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -9446,7 +9471,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -9515,7 +9540,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -9589,7 +9614,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 79, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -9667,7 +9692,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 123, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -9753,7 +9778,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 73, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -9800,10 +9825,4656 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "schema": { + "$ref": "#\/definitions\/tableList" + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "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, rowSecurity", + "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" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "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": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "default": null, + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "default": null, + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column 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": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "schema": { + "$ref": "#\/definitions\/columnIndexList" + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns 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" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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": "tablesDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/logs": { + "get": { + "summary": "List table logs", + "operationId": "databasesListTableLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Get the table activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } + } + }, + "x-appwrite": { + "method": "listTableLogs", + "group": "tables", + "weight": 376, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/list-table-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{}" + }, + "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" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + ] + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + ] + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row 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" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "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" + } + } + } + } + } + ] + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { + "get": { + "summary": "List row logs", + "operationId": "tablesListRowLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get the row activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } + } + }, + "x-appwrite": { + "method": "listRowLogs", + "group": "logs", + "weight": 414, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-row-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row 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" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { + "get": { + "summary": "Get table usage stats", + "operationId": "tablesGetTableUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageTable", + "schema": { + "$ref": "#\/definitions\/usageTable" + } + } + }, + "x-appwrite": { + "method": "getTableUsage", + "group": null, + "weight": 377, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-table-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "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": null, + "x-enum-keys": [], + "default": "30d", + "in": "query" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetDatabaseUsage", + "operationId": "databasesGetUsage", "consumes": [], "produces": [ "application\/json" @@ -9821,13 +14492,13 @@ } }, "x-appwrite": { - "method": "getDatabaseUsage", + "method": "getUsage", "group": null, - "weight": 122, + "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-database-usage.md", + "demo": "databases\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -9857,7 +14528,7 @@ }, { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "type": "string", "x-example": "24h", @@ -9901,7 +14572,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9973,7 +14644,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -10224,7 +14895,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -10273,7 +14944,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -10323,7 +14994,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 404, + "weight": 451, "cookies": false, "type": "", "deprecated": false, @@ -10417,7 +15088,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 403, + "weight": 450, "cookies": false, "type": "", "deprecated": false, @@ -10475,7 +15146,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 397, + "weight": 444, "cookies": false, "type": "", "deprecated": false, @@ -10545,7 +15216,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -10604,7 +15275,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -10851,7 +15522,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -10912,7 +15583,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -10989,7 +15660,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -11069,7 +15740,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -11161,7 +15832,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -11246,7 +15917,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -11352,7 +16023,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -11448,7 +16119,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -11510,7 +16181,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -11577,7 +16248,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -11663,7 +16334,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -11730,7 +16401,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -11804,7 +16475,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -11921,7 +16592,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -11986,7 +16657,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -12053,7 +16724,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 396, + "weight": 443, "cookies": false, "type": "", "deprecated": false, @@ -12131,7 +16802,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -12190,7 +16861,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -12280,7 +16951,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -12347,7 +17018,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -12439,7 +17110,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -12508,7 +17179,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -12582,7 +17253,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -12654,7 +17325,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -12703,7 +17374,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -12752,7 +17423,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -12801,7 +17472,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -12859,7 +17530,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -12908,7 +17579,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -12957,7 +17628,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -13017,7 +17688,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -13077,7 +17748,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -13146,7 +17817,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -13206,7 +17877,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -13290,7 +17961,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -13350,7 +18021,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -13410,7 +18081,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -13470,7 +18141,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -13530,7 +18201,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -13590,7 +18261,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -13650,7 +18321,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -13710,7 +18381,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -13770,7 +18441,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -13819,7 +18490,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -13868,7 +18539,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -13917,7 +18588,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -13969,7 +18640,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -14021,7 +18692,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -14073,7 +18744,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -14125,7 +18796,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -14177,7 +18848,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -14229,7 +18900,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -14281,7 +18952,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -14333,7 +19004,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -14408,7 +19079,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -14566,7 +19237,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -14721,7 +19392,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -14916,7 +19587,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -15110,7 +19781,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -15228,7 +19899,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -15342,7 +20013,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -15397,7 +20068,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -15457,7 +20128,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -15529,7 +20200,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -15601,7 +20272,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -15676,7 +20347,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -15791,7 +20462,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -15904,7 +20575,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -15995,7 +20666,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -16084,7 +20755,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -16211,7 +20882,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -16336,7 +21007,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -16439,7 +21110,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -16540,7 +21211,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -16655,7 +21326,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -16768,7 +21439,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -16927,7 +21598,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -17083,7 +21754,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -17186,7 +21857,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -17287,7 +21958,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -17390,7 +22061,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -17491,7 +22162,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -17594,7 +22265,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -17695,7 +22366,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -17798,7 +22469,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -17897,7 +22568,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -17952,7 +22623,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -18012,7 +22683,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -18084,7 +22755,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -18156,7 +22827,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -18229,7 +22900,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -18317,7 +22988,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -18377,7 +23048,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -18456,7 +23127,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -18516,7 +23187,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -18588,7 +23259,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -18669,7 +23340,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -18757,7 +23428,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -18820,7 +23491,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -18891,7 +23562,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 316, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -18964,7 +23635,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 311, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -19056,7 +23727,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 318, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -19144,7 +23815,7 @@ "x-appwrite": { "method": "createCsvMigration", "group": null, - "weight": 315, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -19228,7 +23899,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 312, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -19306,7 +23977,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 319, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -19377,7 +24048,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 314, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -19496,7 +24167,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 321, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -19616,7 +24287,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 313, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -19728,7 +24399,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 320, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -19839,7 +24510,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 317, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -19897,7 +24568,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 322, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -19950,7 +24621,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 323, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -20008,7 +24679,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 202, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -20090,7 +24761,7 @@ "x-appwrite": { "method": "listVariables", "group": null, - "weight": 204, + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -20138,7 +24809,7 @@ "x-appwrite": { "method": "createVariable", "group": null, - "weight": 203, + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -20219,7 +24890,7 @@ "x-appwrite": { "method": "getVariable", "group": null, - "weight": 205, + "weight": 152, "cookies": false, "type": "", "deprecated": false, @@ -20277,7 +24948,7 @@ "x-appwrite": { "method": "updateVariable", "group": null, - "weight": 206, + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -20360,7 +25031,7 @@ "x-appwrite": { "method": "deleteVariable", "group": null, - "weight": 207, + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -20418,7 +25089,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 157, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -20489,7 +25160,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 156, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -20636,7 +25307,7 @@ "x-appwrite": { "method": "get", "group": "projects", - "weight": 158, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -20694,7 +25365,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 159, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -20819,7 +25490,7 @@ "x-appwrite": { "method": "delete", "group": "projects", - "weight": 176, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -20879,7 +25550,7 @@ "x-appwrite": { "method": "updateApiStatus", "group": "projects", - "weight": 163, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -20971,7 +25642,7 @@ "x-appwrite": { "method": "updateApiStatusAll", "group": "projects", - "weight": 164, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -21049,7 +25720,7 @@ "x-appwrite": { "method": "updateAuthDuration", "group": "auth", - "weight": 169, + "weight": 115, "cookies": false, "type": "", "deprecated": false, @@ -21127,7 +25798,7 @@ "x-appwrite": { "method": "updateAuthLimit", "group": "auth", - "weight": 168, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -21205,7 +25876,7 @@ "x-appwrite": { "method": "updateAuthSessionsLimit", "group": "auth", - "weight": 174, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -21283,7 +25954,7 @@ "x-appwrite": { "method": "updateMembershipsPrivacy", "group": "auth", - "weight": 167, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -21375,7 +26046,7 @@ "x-appwrite": { "method": "updateMockNumbers", "group": "auth", - "weight": 175, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -21456,7 +26127,7 @@ "x-appwrite": { "method": "updateAuthPasswordDictionary", "group": "auth", - "weight": 172, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -21534,7 +26205,7 @@ "x-appwrite": { "method": "updateAuthPasswordHistory", "group": "auth", - "weight": 171, + "weight": 117, "cookies": false, "type": "", "deprecated": false, @@ -21612,7 +26283,7 @@ "x-appwrite": { "method": "updatePersonalDataCheck", "group": "auth", - "weight": 173, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -21690,7 +26361,7 @@ "x-appwrite": { "method": "updateSessionAlerts", "group": "auth", - "weight": 166, + "weight": 112, "cookies": false, "type": "", "deprecated": false, @@ -21743,6 +26414,84 @@ ] } }, + "\/projects\/{projectId}\/auth\/session-invalidation": { + "patch": { + "summary": "Update invalidate session option of the project", + "operationId": "projectsUpdateSessionInvalidation", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "x-appwrite": { + "method": "updateSessionInvalidation", + "group": "auth", + "weight": 148, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-session-invalidation.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, "\/projects\/{projectId}\/auth\/{method}": { "patch": { "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", @@ -21768,7 +26517,7 @@ "x-appwrite": { "method": "updateAuthStatus", "group": "auth", - "weight": 170, + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -21863,7 +26612,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 373, + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -21933,7 +26682,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 370, + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -22016,7 +26765,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 372, + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -22082,7 +26831,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 371, + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -22168,7 +26917,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 374, + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -22236,7 +26985,7 @@ "x-appwrite": { "method": "createJWT", "group": "auth", - "weight": 188, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -22321,7 +27070,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 184, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -22379,7 +27128,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 183, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -22471,7 +27220,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 185, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -22537,7 +27286,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 186, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -22632,7 +27381,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 187, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -22700,7 +27449,7 @@ "x-appwrite": { "method": "updateOAuth2", "group": "auth", - "weight": 165, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -22838,7 +27587,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 190, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -22896,7 +27645,7 @@ "x-appwrite": { "method": "createPlatform", "group": "platforms", - "weight": 189, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -23016,7 +27765,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 191, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -23082,7 +27831,7 @@ "x-appwrite": { "method": "updatePlatform", "group": "platforms", - "weight": 192, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -23179,7 +27928,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 193, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -23247,7 +27996,7 @@ "x-appwrite": { "method": "updateServiceStatus", "group": "projects", - "weight": 161, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -23348,7 +28097,7 @@ "x-appwrite": { "method": "updateServiceStatusAll", "group": "projects", - "weight": 162, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -23426,7 +28175,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 194, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -23555,7 +28304,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 195, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -23693,7 +28442,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 160, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -23769,7 +28518,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 197, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -23989,7 +28738,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 199, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -24252,7 +29001,7 @@ "x-appwrite": { "method": "deleteEmailTemplate", "group": "templates", - "weight": 201, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -24472,7 +29221,7 @@ "x-appwrite": { "method": "getSmsTemplate", "group": "templates", - "weight": 196, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -24689,7 +29438,7 @@ "x-appwrite": { "method": "updateSmsTemplate", "group": "templates", - "weight": 198, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -24924,7 +29673,7 @@ "x-appwrite": { "method": "deleteSmsTemplate", "group": "templates", - "weight": 200, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -25141,7 +29890,7 @@ "x-appwrite": { "method": "listWebhooks", "group": "webhooks", - "weight": 178, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -25199,7 +29948,7 @@ "x-appwrite": { "method": "createWebhook", "group": "webhooks", - "weight": 177, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -25317,7 +30066,7 @@ "x-appwrite": { "method": "getWebhook", "group": "webhooks", - "weight": 179, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -25383,7 +30132,7 @@ "x-appwrite": { "method": "updateWebhook", "group": "webhooks", - "weight": 180, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -25504,7 +30253,7 @@ "x-appwrite": { "method": "deleteWebhook", "group": "webhooks", - "weight": 182, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -25572,7 +30321,7 @@ "x-appwrite": { "method": "updateWebhookSignature", "group": "webhooks", - "weight": 181, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -25638,7 +30387,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 294, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -25711,7 +30460,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 435, + "weight": 482, "cookies": false, "type": "", "deprecated": false, @@ -25781,7 +30530,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 437, + "weight": 484, "cookies": false, "type": "", "deprecated": false, @@ -25864,7 +30613,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 438, + "weight": 485, "cookies": false, "type": "", "deprecated": false, @@ -25984,7 +30733,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 436, + "weight": 483, "cookies": false, "type": "", "deprecated": false, @@ -26065,7 +30814,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 295, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -26118,7 +30867,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 296, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -26178,7 +30927,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 297, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -26236,7 +30985,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -26308,7 +31057,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -26575,7 +31324,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -26624,7 +31373,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -26674,7 +31423,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 429, + "weight": 476, "cookies": false, "type": "", "deprecated": false, @@ -26768,7 +31517,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 430, + "weight": 477, "cookies": false, "type": "", "deprecated": false, @@ -26826,7 +31575,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 431, + "weight": 478, "cookies": false, "type": "", "deprecated": false, @@ -26896,7 +31645,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -26955,7 +31704,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -27217,7 +31966,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -27278,7 +32027,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -27355,7 +32104,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -27435,7 +32184,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -27535,7 +32284,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -27614,7 +32363,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -27720,7 +32469,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -27817,7 +32566,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -27879,7 +32628,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -27946,7 +32695,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -28032,7 +32781,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -28099,7 +32848,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -28170,7 +32919,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -28234,7 +32983,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -28301,7 +33050,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 432, + "weight": 479, "cookies": false, "type": "", "deprecated": false, @@ -28379,7 +33128,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -28438,7 +33187,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -28528,7 +33277,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -28595,7 +33344,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -28687,7 +33436,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -28754,7 +33503,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -28826,7 +33575,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -28963,7 +33712,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -29022,7 +33771,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -29155,7 +33904,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -29214,7 +33963,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -29297,7 +34046,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -29387,7 +34136,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -29457,7 +34206,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -29546,7 +34295,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -29616,7 +34365,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -29695,7 +34444,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -29902,7 +34651,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -29981,7 +34730,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 222, + "weight": 169, "cookies": false, "type": "", "deprecated": false, @@ -30051,7 +34800,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 223, + "weight": 170, "cookies": false, "type": "", "deprecated": false, @@ -30129,7 +34878,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -30204,7 +34953,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -30294,7 +35043,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -30356,7 +35105,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -30431,7 +35180,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -30493,7 +35242,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 237, + "weight": 184, "cookies": false, "type": "", "deprecated": false, @@ -30563,7 +35312,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -30646,7 +35395,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -30759,7 +35508,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -30829,7 +35578,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -30915,7 +35664,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -30987,7 +35736,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -31080,7 +35829,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -31140,7 +35889,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -31218,7 +35967,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -31298,7 +36047,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -31382,7 +36131,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -31442,7 +36191,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -31513,7 +36262,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -31573,7 +36322,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -31645,7 +36394,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -31740,7 +36489,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -31831,7 +36580,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -31920,7 +36669,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -31989,7 +36738,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -32050,7 +36799,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -32141,7 +36890,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -32232,7 +36981,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -32358,7 +37107,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -32470,7 +37219,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -32580,7 +37329,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 280, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -32650,7 +37399,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -32704,7 +37453,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -32765,7 +37514,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -32844,7 +37593,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -32926,7 +37675,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -33006,7 +37755,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -33077,7 +37826,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -33159,7 +37908,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -33233,7 +37982,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -33305,7 +38054,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -33364,7 +38113,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -33423,7 +38172,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -33482,7 +38231,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -33543,7 +38292,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -33622,7 +38371,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -33701,7 +38450,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -33778,7 +38527,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -33837,7 +38586,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -33914,7 +38663,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -33973,7 +38722,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -34027,7 +38776,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -34083,7 +38832,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -34152,7 +38901,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -34229,7 +38978,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -34301,7 +39050,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -34412,7 +39161,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -34480,7 +39229,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -34570,7 +39319,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -34640,7 +39389,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -34722,7 +39471,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -34801,7 +39550,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -34880,7 +39629,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 284, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -34975,7 +39724,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 285, + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -35056,7 +39805,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 286, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -35139,7 +39888,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 287, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -35205,7 +39954,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 288, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -35271,7 +40020,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 283, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -35319,6 +40068,15 @@ "x-example": "", "default": "", "in": "query" + }, + { + "name": "providerReference", + "description": "Git reference (branch, tag, commit) to get contents from", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -35345,7 +40103,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 293, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -35429,7 +40187,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 290, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -35500,7 +40258,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 291, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -35553,7 +40311,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 292, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -35665,13 +40423,38 @@ "type": "object", "additionalProperties": true }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "type": "object", + "$ref": "#\/definitions\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35690,13 +40473,38 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35721,7 +40529,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35746,7 +40554,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35765,13 +40573,38 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35796,7 +40629,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35821,7 +40654,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35846,7 +40679,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35871,7 +40704,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35896,7 +40729,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35921,7 +40754,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35946,7 +40779,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35971,7 +40804,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35996,7 +40829,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36021,7 +40854,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36046,7 +40879,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36071,7 +40904,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36096,7 +40929,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of installations documents that matched your query.", + "description": "Total number of installations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36121,7 +40954,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworkProviderRepositories documents that matched your query.", + "description": "Total number of frameworkProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36146,7 +40979,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimeProviderRepositories documents that matched your query.", + "description": "Total number of runtimeProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36171,7 +41004,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of branches documents that matched your query.", + "description": "Total number of branches rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36196,7 +41029,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36221,7 +41054,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36246,7 +41079,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36271,7 +41104,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36296,7 +41129,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of projects documents that matched your query.", + "description": "Total number of projects rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36321,7 +41154,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of webhooks documents that matched your query.", + "description": "Total number of webhooks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36346,7 +41179,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of keys documents that matched your query.", + "description": "Total number of keys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36371,7 +41204,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of devKeys documents that matched your query.", + "description": "Total number of devKeys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36396,7 +41229,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of platforms documents that matched your query.", + "description": "Total number of platforms rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36421,7 +41254,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36446,7 +41279,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36471,7 +41304,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36496,7 +41329,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36521,7 +41354,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36546,7 +41379,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36571,7 +41404,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of rules documents that matched your query.", + "description": "Total number of rules rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36596,7 +41429,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36621,7 +41454,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36646,7 +41479,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36671,7 +41504,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36696,7 +41529,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36721,7 +41554,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36746,7 +41579,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of migrations documents that matched your query.", + "description": "Total number of migrations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36771,7 +41604,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36796,7 +41629,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of contents documents that matched your query.", + "description": "Total number of contents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -37751,6 +42584,904 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -37823,6 +43554,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", @@ -40732,6 +46592,11 @@ "description": "Whether or not to show user MFA status in the teams membership response.", "x-example": true }, + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true + }, "oAuthProviders": { "type": "array", "description": "List of Auth Providers.", @@ -40958,6 +46823,7 @@ "authMembershipsUserName", "authMembershipsUserEmail", "authMembershipsMfa", + "authInvalidateSessions", "oAuthProviders", "platforms", "webhooks", @@ -41030,7 +46896,10 @@ "items": { "type": "string" }, - "x-example": "database.collections.update" + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] }, "security": { "type": "boolean", @@ -41749,12 +47618,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total databases storage in bytes.", @@ -41791,6 +47672,15 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41800,6 +47690,15 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "An array of the aggregated number of databases storage in bytes per period.", @@ -41832,13 +47731,17 @@ "range", "databasesTotal", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databasesReadsTotal", "databasesWritesTotal", "databases", "collections", + "tables", "documents", + "rows", "storage", "databasesReads", "databasesWrites" @@ -41859,12 +47762,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total storage used in bytes.", @@ -41892,6 +47807,15 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41901,6 +47825,15 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "Aggregated storage used in bytes per period.", @@ -41932,17 +47865,52 @@ "required": [ "range", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databaseReadsTotal", "databaseWritesTotal", "collections", + "tables", "documents", + "rows", "storage", "databaseReads", "databaseWrites" ] }, + "usageTable": { + "description": "UsageTable", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of of rows.", + "x-example": 0, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "rowsTotal", + "rows" + ] + }, "usageCollection": { "description": "UsageCollection", "type": "object", @@ -43122,6 +49090,12 @@ "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "databasesTotal": { "type": "integer", "description": "Total aggregated number of databases.", @@ -43342,6 +49316,7 @@ "required": [ "executionsTotal", "documentsTotal", + "rowsTotal", "databasesTotal", "databasesStorageTotal", "usersTotal", diff --git a/app/config/specs/swagger2-1.8.x-server.json b/app/config/specs/swagger2-1.8.x-server.json index 7c15f9e5ea..215735cdb9 100644 --- a/app/config/specs/swagger2-1.8.x-server.json +++ b/app/config/specs/swagger2-1.8.x-server.json @@ -4215,7 +4215,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4288,7 +4288,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4371,7 +4371,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4431,7 +4431,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -4510,7 +4510,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -4570,7 +4570,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -4628,7 +4628,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "consumes": [ "application\/json" @@ -4651,7 +4651,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -4757,7 +4757,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -4825,7 +4825,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -4927,7 +4927,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -4995,7 +4995,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -5031,7 +5031,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5077,7 +5077,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -5113,7 +5113,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -5184,7 +5184,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5220,7 +5220,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5293,7 +5293,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5329,7 +5329,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5377,7 +5377,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "consumes": [ "application\/json" @@ -5400,7 +5400,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5436,7 +5436,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5509,7 +5509,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5545,7 +5545,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5616,7 +5616,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -5652,7 +5652,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5686,7 +5686,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -5713,7 +5713,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -5725,12 +5725,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5761,7 +5761,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5781,7 +5781,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "default": null, "x-example": null, "items": { @@ -5842,7 +5842,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -5878,7 +5878,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5899,7 +5899,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "default": null, "x-example": null, "items": { @@ -5921,7 +5921,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -5961,7 +5961,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -5997,7 +5997,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6023,19 +6023,19 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null }, @@ -6080,7 +6080,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -6116,7 +6116,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6143,26 +6143,26 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6201,7 +6201,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6237,7 +6237,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6263,19 +6263,19 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -6320,7 +6320,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6356,7 +6356,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6383,26 +6383,26 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6441,7 +6441,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -6477,7 +6477,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6503,7 +6503,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -6548,7 +6548,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -6584,7 +6584,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6611,14 +6611,14 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6657,7 +6657,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -6693,7 +6693,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6707,7 +6707,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "default": null, "x-example": "" }, @@ -6791,7 +6791,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -6827,7 +6827,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -6911,7 +6911,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -6947,7 +6947,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -6987,7 +6987,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7026,7 +7026,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -7062,7 +7062,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7133,7 +7133,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7169,7 +7169,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7203,7 +7203,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7271,7 +7271,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7307,7 +7307,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7341,7 +7341,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7377,7 +7377,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7418,7 +7418,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7454,7 +7454,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7488,7 +7488,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7521,7 +7521,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -7605,7 +7605,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -7616,7 +7616,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -7626,7 +7625,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -7762,7 +7760,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "schema": { "$ref": "#\/definitions\/documentList" @@ -7772,7 +7770,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -7787,6 +7785,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [], "Key": [] @@ -7862,7 +7878,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -7955,7 +7971,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -8042,7 +8058,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8111,7 +8127,7 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "consumes": [ "application\/json" @@ -8124,7 +8140,7 @@ ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -8134,7 +8150,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8150,6 +8166,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [], "Session": [] @@ -8241,7 +8276,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8340,7 +8375,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8422,7 +8457,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -8434,8 +8469,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8447,9 +8480,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8492,7 +8523,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "default": 1, "x-example": null }, @@ -8533,7 +8564,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -8545,8 +8576,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8558,9 +8587,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8642,7 +8669,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -8721,8 +8748,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -8850,7 +8877,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -8920,7 +8947,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -8972,6 +8999,4455 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "schema": { + "$ref": "#\/definitions\/tableList" + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "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, rowSecurity", + "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" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "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": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "default": null, + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "default": null, + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column 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": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "schema": { + "$ref": "#\/definitions\/columnIndexList" + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns 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" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "tablesDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{}" + }, + "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" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + ] + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + ] + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "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" + } + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row 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" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "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" + } + } + } + } + } + ] + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, "\/functions": { "get": { "summary": "List functions", @@ -8995,7 +13471,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9068,7 +13544,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -9320,7 +13796,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -9370,7 +13846,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -9421,7 +13897,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -9481,7 +13957,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -9729,7 +14205,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -9791,7 +14267,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -9869,7 +14345,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -9950,7 +14426,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -10043,7 +14519,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -10129,7 +14605,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -10236,7 +14712,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -10333,7 +14809,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -10396,7 +14872,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -10464,7 +14940,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -10551,7 +15027,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -10619,7 +15095,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -10695,7 +15171,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -10814,7 +15290,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -10881,7 +15357,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -10949,7 +15425,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -11009,7 +15485,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -11100,7 +15576,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -11168,7 +15644,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -11261,7 +15737,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -11331,7 +15807,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -11407,7 +15883,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -11481,7 +15957,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -11531,7 +16007,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -11581,7 +16057,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -11631,7 +16107,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -11690,7 +16166,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -11740,7 +16216,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -11790,7 +16266,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -11851,7 +16327,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -11912,7 +16388,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -11982,7 +16458,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -12043,7 +16519,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -12128,7 +16604,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -12189,7 +16665,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -12250,7 +16726,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -12311,7 +16787,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -12372,7 +16848,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -12433,7 +16909,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -12494,7 +16970,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -12555,7 +17031,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -12616,7 +17092,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -12666,7 +17142,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -12716,7 +17192,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -12766,7 +17242,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -12820,7 +17296,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -12874,7 +17350,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -12928,7 +17404,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -12982,7 +17458,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -13036,7 +17512,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -13090,7 +17566,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -13144,7 +17620,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -13198,7 +17674,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -13274,7 +17750,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -13433,7 +17909,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -13589,7 +18065,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -13785,7 +18261,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -13980,7 +18456,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -14099,7 +18575,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -14214,7 +18690,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -14270,7 +18746,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -14331,7 +18807,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -14404,7 +18880,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -14477,7 +18953,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -14553,7 +19029,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -14669,7 +19145,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -14783,7 +19259,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -14875,7 +19351,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -14965,7 +19441,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -15093,7 +19569,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -15219,7 +19695,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -15323,7 +19799,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -15425,7 +19901,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -15541,7 +20017,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -15655,7 +20131,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -15815,7 +20291,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -15972,7 +20448,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -16076,7 +20552,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -16178,7 +20654,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -16282,7 +20758,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -16384,7 +20860,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -16488,7 +20964,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -16590,7 +21066,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -16694,7 +21170,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -16794,7 +21270,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -16850,7 +21326,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -16911,7 +21387,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -16984,7 +21460,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -17057,7 +21533,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -17131,7 +21607,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -17220,7 +21696,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -17281,7 +21757,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -17361,7 +21837,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -17422,7 +21898,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -17495,7 +21971,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -17577,7 +22053,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -17667,7 +22143,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -17731,7 +22207,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -17804,7 +22280,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -17877,7 +22353,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -18145,7 +22621,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -18195,7 +22671,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -18246,7 +22722,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -18306,7 +22782,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -18569,7 +23045,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -18631,7 +23107,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -18709,7 +23185,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -18790,7 +23266,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -18891,7 +23367,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -18971,7 +23447,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -19078,7 +23554,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -19176,7 +23652,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -19239,7 +23715,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -19307,7 +23783,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -19394,7 +23870,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -19462,7 +23938,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -19534,7 +24010,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -19599,7 +24075,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -19667,7 +24143,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -19727,7 +24203,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -19818,7 +24294,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -19886,7 +24362,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -19979,7 +24455,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -20047,7 +24523,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -20120,7 +24596,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -20258,7 +24734,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -20318,7 +24794,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -20452,7 +24928,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -20512,7 +24988,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -20597,7 +25073,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -20689,7 +25165,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -20761,7 +25237,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -20852,7 +25328,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -20924,7 +25400,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -21005,7 +25481,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -21214,7 +25690,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -21295,7 +25771,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -21372,7 +25848,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -21464,7 +25940,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -21528,7 +26004,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -21605,7 +26081,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -21669,7 +26145,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -21754,7 +26230,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -21869,7 +26345,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -21941,7 +26417,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -22029,7 +26505,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -22103,7 +26579,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -22198,7 +26674,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -22260,7 +26736,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -22340,7 +26816,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -22421,7 +26897,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -22506,7 +26982,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -22567,7 +27043,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -22639,7 +27115,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -22700,7 +27176,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22773,7 +27249,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -22869,7 +27345,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -22961,7 +27437,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -23051,7 +27527,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -23121,7 +27597,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -23183,7 +27659,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -23275,7 +27751,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -23367,7 +27843,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -23494,7 +27970,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -23607,7 +28083,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -23718,7 +28194,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23773,7 +28249,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -23835,7 +28311,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -23915,7 +28391,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -23998,7 +28474,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -24079,7 +28555,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -24151,7 +28627,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -24234,7 +28710,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -24309,7 +28785,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -24382,7 +28858,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -24442,7 +28918,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -24502,7 +28978,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -24562,7 +29038,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -24624,7 +29100,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -24704,7 +29180,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -24784,7 +29260,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -24862,7 +29338,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -24922,7 +29398,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -25000,7 +29476,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -25060,7 +29536,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -25115,7 +29591,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -25172,7 +29648,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -25242,7 +29718,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -25320,7 +29796,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -25393,7 +29869,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -25505,7 +29981,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -25574,7 +30050,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -25665,7 +30141,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -25736,7 +30212,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -25819,7 +30295,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -25899,7 +30375,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -26031,13 +30507,38 @@ "type": "object", "additionalProperties": true }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "type": "object", + "$ref": "#\/definitions\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26056,13 +30557,38 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26087,7 +30613,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26112,7 +30638,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26131,13 +30657,38 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26162,7 +30713,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26187,7 +30738,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26212,7 +30763,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26237,7 +30788,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26262,7 +30813,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26287,7 +30838,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26312,7 +30863,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26337,7 +30888,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26362,7 +30913,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26387,7 +30938,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26412,7 +30963,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26437,7 +30988,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26462,7 +31013,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26487,7 +31038,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26512,7 +31063,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26537,7 +31088,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26562,7 +31113,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26587,7 +31138,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26612,7 +31163,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26637,7 +31188,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26662,7 +31213,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26687,7 +31238,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26712,7 +31263,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26737,7 +31288,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26762,7 +31313,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26787,7 +31338,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26812,7 +31363,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -27767,6 +32318,904 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -27839,6 +33288,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", diff --git a/app/config/specs/swagger2-latest-client.json b/app/config/specs/swagger2-latest-client.json index e369e2f0f3..84445b4af5 100644 --- a/app/config/specs/swagger2-latest-client.json +++ b/app/config/specs/swagger2-latest-client.json @@ -4510,7 +4510,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -4592,7 +4592,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -4603,7 +4603,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -4613,7 +4612,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -4642,6 +4640,7 @@ { "name": "createDocuments", "auth": { + "Admin": [], "Key": [] }, "parameters": [ @@ -4756,7 +4755,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -4823,7 +4822,7 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "consumes": [ "application\/json" @@ -4836,7 +4835,7 @@ ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -4846,7 +4845,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -4862,6 +4861,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -4951,7 +4969,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -5048,7 +5066,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -5103,45 +5121,42 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" + "tables" ], - "description": "Decrement a specific attribute of a document by a given value.", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "Document", + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/rowList" } } }, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 116, + "method": "listRows", + "group": "rows", + "weight": 413, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/decrement-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5166,26 +5181,147 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -5194,17 +5330,35 @@ "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 + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{}" + }, + "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": null + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } } } @@ -5212,45 +5366,42 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" + "tables" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", "responses": { "200": { - "description": "Document", + "description": "Row", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/row" } } }, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 115, + "method": "getRow", + "group": "rows", + "weight": 406, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/increment-document-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", "platforms": [ - "console", - "server", "client", + "server", "server" ], "packaging": false, @@ -5275,26 +5426,128 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "rowId", + "description": "Row ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "attribute", - "description": "Attribute key.", + "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" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -5303,22 +5556,200 @@ "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 + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "default": [], + "x-example": "{}" }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "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": null + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } } } } } ] + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] } }, "\/functions\/{functionId}\/executions": { @@ -5344,7 +5775,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -5418,7 +5849,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -5535,7 +5966,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -5607,7 +6038,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -5681,7 +6112,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -5753,7 +6184,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -5805,7 +6236,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -5857,7 +6288,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -5909,7 +6340,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -5961,7 +6392,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -6013,7 +6444,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -6065,7 +6496,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -6117,7 +6548,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -6171,7 +6602,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -6256,7 +6687,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -6327,7 +6758,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -6410,7 +6841,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -6500,7 +6931,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -6570,7 +7001,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -6659,7 +7090,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -6729,7 +7160,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -6808,7 +7239,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -7015,7 +7446,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -7094,7 +7525,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -7169,7 +7600,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -7259,7 +7690,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -7321,7 +7752,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -7396,7 +7827,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -7458,7 +7889,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -7541,7 +7972,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -7654,7 +8085,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -7724,7 +8155,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -7810,7 +8241,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -7882,7 +8313,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -7976,7 +8407,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -8037,7 +8468,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -8170,13 +8601,38 @@ "type": "object", "additionalProperties": true }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "type": "object", + "$ref": "#\/definitions\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8201,7 +8657,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8226,7 +8682,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8251,7 +8707,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8276,7 +8732,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8301,7 +8757,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8326,7 +8782,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8351,7 +8807,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8376,7 +8832,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8401,7 +8857,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8426,7 +8882,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8451,7 +8907,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8476,7 +8932,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8501,7 +8957,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -8520,6 +8976,63 @@ "localeCodes" ] }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", diff --git a/app/config/specs/swagger2-latest-console.json b/app/config/specs/swagger2-latest-console.json index da959a8180..4ac2c7b317 100644 --- a/app/config/specs/swagger2-latest-console.json +++ b/app/config/specs/swagger2-latest-console.json @@ -4527,7 +4527,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 310, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -4590,7 +4590,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 434, + "weight": 481, "cookies": false, "type": "", "deprecated": false, @@ -4661,7 +4661,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 309, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -4709,7 +4709,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4781,7 +4781,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4843,7 +4843,7 @@ "\/databases\/usage": { "get": { "summary": "Get databases usage stats", - "operationId": "databasesGetUsage", + "operationId": "databasesListUsages", "consumes": [], "produces": [ "application\/json" @@ -4861,13 +4861,13 @@ } }, "x-appwrite": { - "method": "getUsage", + "method": "listUsages", "group": null, - "weight": 121, + "weight": 324, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-usage.md", + "demo": "databases\/list-usages.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -4889,7 +4889,7 @@ "parameters": [ { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "type": "string", "x-example": "24h", @@ -4898,12 +4898,8 @@ "30d", "90d" ], - "x-enum-name": "DatabaseUsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], + "x-enum-name": null, + "x-enum-keys": [], "default": "30d", "in": "query" } @@ -4933,7 +4929,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4992,7 +4988,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -5070,7 +5066,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -5129,7 +5125,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -5186,7 +5182,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "consumes": [ "application\/json" @@ -5209,7 +5205,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -5314,7 +5310,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -5381,7 +5377,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -5482,7 +5478,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -5549,7 +5545,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -5584,7 +5580,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5630,7 +5626,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -5665,7 +5661,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -5736,7 +5732,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5771,7 +5767,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5844,7 +5840,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5879,7 +5875,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5927,7 +5923,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "consumes": [ "application\/json" @@ -5950,7 +5946,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5985,7 +5981,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6058,7 +6054,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -6093,7 +6089,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6164,7 +6160,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -6199,7 +6195,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6233,7 +6229,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6260,7 +6256,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -6272,12 +6268,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -6307,7 +6303,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6327,7 +6323,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "default": null, "x-example": null, "items": { @@ -6388,7 +6384,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -6423,7 +6419,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6444,7 +6440,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "default": null, "x-example": null, "items": { @@ -6466,7 +6462,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6506,7 +6502,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -6541,7 +6537,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6567,19 +6563,19 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null }, @@ -6624,7 +6620,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -6659,7 +6655,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6686,26 +6682,26 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6744,7 +6740,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6779,7 +6775,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6805,19 +6801,19 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -6862,7 +6858,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6897,7 +6893,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6924,26 +6920,26 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6982,7 +6978,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -7017,7 +7013,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7043,7 +7039,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -7088,7 +7084,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -7123,7 +7119,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7150,14 +7146,14 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7196,7 +7192,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -7231,7 +7227,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7245,7 +7241,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "default": null, "x-example": "" }, @@ -7329,7 +7325,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -7364,7 +7360,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -7448,7 +7444,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -7483,7 +7479,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -7523,7 +7519,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7562,7 +7558,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -7597,7 +7593,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7668,7 +7664,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7703,7 +7699,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7737,7 +7733,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7805,7 +7801,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7840,7 +7836,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7874,7 +7870,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7909,7 +7905,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7950,7 +7946,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7985,7 +7981,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -8019,7 +8015,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -8052,7 +8048,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -8134,7 +8130,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -8145,7 +8141,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -8155,7 +8150,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -8289,7 +8283,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "schema": { "$ref": "#\/definitions\/documentList" @@ -8299,7 +8293,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -8314,6 +8308,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [] } @@ -8388,7 +8400,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -8480,7 +8492,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -8566,7 +8578,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8633,7 +8645,7 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "consumes": [ "application\/json" @@ -8646,7 +8658,7 @@ ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -8656,7 +8668,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8672,6 +8684,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -8761,7 +8792,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8858,7 +8889,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8936,7 +8967,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 112, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -9024,7 +9055,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -9036,8 +9067,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -9048,8 +9077,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9092,7 +9120,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "default": 1, "x-example": null }, @@ -9133,7 +9161,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -9145,8 +9173,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -9157,8 +9183,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -9240,7 +9265,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -9318,8 +9343,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -9446,7 +9471,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -9515,7 +9540,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -9589,7 +9614,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 79, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -9667,7 +9692,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 123, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -9753,7 +9778,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 73, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -9800,10 +9825,4656 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "schema": { + "$ref": "#\/definitions\/tableList" + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "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, rowSecurity", + "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" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "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": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "default": null, + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "default": null, + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column 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": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "schema": { + "$ref": "#\/definitions\/columnIndexList" + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns 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" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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": "tablesDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/logs": { + "get": { + "summary": "List table logs", + "operationId": "databasesListTableLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Get the table activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } + } + }, + "x-appwrite": { + "method": "listTableLogs", + "group": "tables", + "weight": 376, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/list-table-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{}" + }, + "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" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + ] + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + ] + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row 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" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "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" + } + } + } + } + } + ] + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { + "get": { + "summary": "List row logs", + "operationId": "tablesListRowLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get the row activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } + } + }, + "x-appwrite": { + "method": "listRowLogs", + "group": "logs", + "weight": 414, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-row-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row 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" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/usage": { + "get": { + "summary": "Get table usage stats", + "operationId": "tablesGetTableUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageTable", + "schema": { + "$ref": "#\/definitions\/usageTable" + } + } + }, + "x-appwrite": { + "method": "getTableUsage", + "group": null, + "weight": 377, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-table-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "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": null, + "x-enum-keys": [], + "default": "30d", + "in": "query" + }, + { + "name": "tableId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, "\/databases\/{databaseId}\/usage": { "get": { "summary": "Get database usage stats", - "operationId": "databasesGetDatabaseUsage", + "operationId": "databasesGetUsage", "consumes": [], "produces": [ "application\/json" @@ -9821,13 +14492,13 @@ } }, "x-appwrite": { - "method": "getDatabaseUsage", + "method": "getUsage", "group": null, - "weight": 122, + "weight": 323, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-database-usage.md", + "demo": "databases\/get-usage.md", "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "rate-limit": 0, "rate-time": 3600, @@ -9857,7 +14528,7 @@ }, { "name": "range", - "description": "`Date range.", + "description": "Date range.", "required": false, "type": "string", "x-example": "24h", @@ -9901,7 +14572,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9973,7 +14644,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -10224,7 +14895,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -10273,7 +14944,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -10323,7 +14994,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 404, + "weight": 451, "cookies": false, "type": "", "deprecated": false, @@ -10417,7 +15088,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 403, + "weight": 450, "cookies": false, "type": "", "deprecated": false, @@ -10475,7 +15146,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 397, + "weight": 444, "cookies": false, "type": "", "deprecated": false, @@ -10545,7 +15216,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -10604,7 +15275,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -10851,7 +15522,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -10912,7 +15583,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -10989,7 +15660,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -11069,7 +15740,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -11161,7 +15832,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -11246,7 +15917,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -11352,7 +16023,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -11448,7 +16119,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -11510,7 +16181,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -11577,7 +16248,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -11663,7 +16334,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -11730,7 +16401,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -11804,7 +16475,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -11921,7 +16592,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -11986,7 +16657,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -12053,7 +16724,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 396, + "weight": 443, "cookies": false, "type": "", "deprecated": false, @@ -12131,7 +16802,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -12190,7 +16861,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -12280,7 +16951,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -12347,7 +17018,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -12439,7 +17110,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -12508,7 +17179,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -12582,7 +17253,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -12654,7 +17325,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -12703,7 +17374,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -12752,7 +17423,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -12801,7 +17472,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -12859,7 +17530,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -12908,7 +17579,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -12957,7 +17628,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -13017,7 +17688,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -13077,7 +17748,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -13146,7 +17817,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -13206,7 +17877,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -13290,7 +17961,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -13350,7 +18021,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -13410,7 +18081,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -13470,7 +18141,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -13530,7 +18201,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -13590,7 +18261,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -13650,7 +18321,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -13710,7 +18381,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -13770,7 +18441,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -13819,7 +18490,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -13868,7 +18539,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -13917,7 +18588,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -13969,7 +18640,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -14021,7 +18692,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -14073,7 +18744,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -14125,7 +18796,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -14177,7 +18848,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -14229,7 +18900,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -14281,7 +18952,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -14333,7 +19004,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -14408,7 +19079,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -14566,7 +19237,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -14721,7 +19392,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -14916,7 +19587,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -15110,7 +19781,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -15228,7 +19899,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -15342,7 +20013,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -15397,7 +20068,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -15457,7 +20128,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -15529,7 +20200,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -15601,7 +20272,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -15676,7 +20347,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -15791,7 +20462,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -15904,7 +20575,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -15995,7 +20666,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -16084,7 +20755,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -16211,7 +20882,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -16336,7 +21007,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -16439,7 +21110,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -16540,7 +21211,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -16655,7 +21326,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -16768,7 +21439,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -16927,7 +21598,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -17083,7 +21754,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -17186,7 +21857,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -17287,7 +21958,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -17390,7 +22061,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -17491,7 +22162,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -17594,7 +22265,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -17695,7 +22366,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -17798,7 +22469,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -17897,7 +22568,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -17952,7 +22623,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -18012,7 +22683,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -18084,7 +22755,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -18156,7 +22827,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -18229,7 +22900,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -18317,7 +22988,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -18377,7 +23048,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -18456,7 +23127,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -18516,7 +23187,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -18588,7 +23259,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -18669,7 +23340,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -18757,7 +23428,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -18820,7 +23491,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -18891,7 +23562,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 316, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -18964,7 +23635,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 311, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -19056,7 +23727,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 318, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -19144,7 +23815,7 @@ "x-appwrite": { "method": "createCsvMigration", "group": null, - "weight": 315, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -19228,7 +23899,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 312, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -19306,7 +23977,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 319, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -19377,7 +24048,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 314, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -19496,7 +24167,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 321, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -19616,7 +24287,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 313, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -19728,7 +24399,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 320, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -19839,7 +24510,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 317, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -19897,7 +24568,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 322, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -19950,7 +24621,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 323, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -20008,7 +24679,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 202, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -20090,7 +24761,7 @@ "x-appwrite": { "method": "listVariables", "group": null, - "weight": 204, + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -20138,7 +24809,7 @@ "x-appwrite": { "method": "createVariable", "group": null, - "weight": 203, + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -20219,7 +24890,7 @@ "x-appwrite": { "method": "getVariable", "group": null, - "weight": 205, + "weight": 152, "cookies": false, "type": "", "deprecated": false, @@ -20277,7 +24948,7 @@ "x-appwrite": { "method": "updateVariable", "group": null, - "weight": 206, + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -20360,7 +25031,7 @@ "x-appwrite": { "method": "deleteVariable", "group": null, - "weight": 207, + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -20418,7 +25089,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 157, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -20489,7 +25160,7 @@ "x-appwrite": { "method": "create", "group": "projects", - "weight": 156, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -20636,7 +25307,7 @@ "x-appwrite": { "method": "get", "group": "projects", - "weight": 158, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -20694,7 +25365,7 @@ "x-appwrite": { "method": "update", "group": "projects", - "weight": 159, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -20819,7 +25490,7 @@ "x-appwrite": { "method": "delete", "group": "projects", - "weight": 176, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -20879,7 +25550,7 @@ "x-appwrite": { "method": "updateApiStatus", "group": "projects", - "weight": 163, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -20971,7 +25642,7 @@ "x-appwrite": { "method": "updateApiStatusAll", "group": "projects", - "weight": 164, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -21049,7 +25720,7 @@ "x-appwrite": { "method": "updateAuthDuration", "group": "auth", - "weight": 169, + "weight": 115, "cookies": false, "type": "", "deprecated": false, @@ -21127,7 +25798,7 @@ "x-appwrite": { "method": "updateAuthLimit", "group": "auth", - "weight": 168, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -21205,7 +25876,7 @@ "x-appwrite": { "method": "updateAuthSessionsLimit", "group": "auth", - "weight": 174, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -21283,7 +25954,7 @@ "x-appwrite": { "method": "updateMembershipsPrivacy", "group": "auth", - "weight": 167, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -21375,7 +26046,7 @@ "x-appwrite": { "method": "updateMockNumbers", "group": "auth", - "weight": 175, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -21456,7 +26127,7 @@ "x-appwrite": { "method": "updateAuthPasswordDictionary", "group": "auth", - "weight": 172, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -21534,7 +26205,7 @@ "x-appwrite": { "method": "updateAuthPasswordHistory", "group": "auth", - "weight": 171, + "weight": 117, "cookies": false, "type": "", "deprecated": false, @@ -21612,7 +26283,7 @@ "x-appwrite": { "method": "updatePersonalDataCheck", "group": "auth", - "weight": 173, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -21690,7 +26361,7 @@ "x-appwrite": { "method": "updateSessionAlerts", "group": "auth", - "weight": 166, + "weight": 112, "cookies": false, "type": "", "deprecated": false, @@ -21743,6 +26414,84 @@ ] } }, + "\/projects\/{projectId}\/auth\/session-invalidation": { + "patch": { + "summary": "Update invalidate session option of the project", + "operationId": "projectsUpdateSessionInvalidation", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "x-appwrite": { + "method": "updateSessionInvalidation", + "group": "auth", + "weight": 148, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-session-invalidation.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, "\/projects\/{projectId}\/auth\/{method}": { "patch": { "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", @@ -21768,7 +26517,7 @@ "x-appwrite": { "method": "updateAuthStatus", "group": "auth", - "weight": 170, + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -21863,7 +26612,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 373, + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -21933,7 +26682,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 370, + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -22016,7 +26765,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 372, + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -22082,7 +26831,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 371, + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -22168,7 +26917,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 374, + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -22236,7 +26985,7 @@ "x-appwrite": { "method": "createJWT", "group": "auth", - "weight": 188, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -22321,7 +27070,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 184, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -22379,7 +27128,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 183, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -22471,7 +27220,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 185, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -22537,7 +27286,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 186, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -22632,7 +27381,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 187, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -22700,7 +27449,7 @@ "x-appwrite": { "method": "updateOAuth2", "group": "auth", - "weight": 165, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -22838,7 +27587,7 @@ "x-appwrite": { "method": "listPlatforms", "group": "platforms", - "weight": 190, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -22896,7 +27645,7 @@ "x-appwrite": { "method": "createPlatform", "group": "platforms", - "weight": 189, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -23016,7 +27765,7 @@ "x-appwrite": { "method": "getPlatform", "group": "platforms", - "weight": 191, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -23082,7 +27831,7 @@ "x-appwrite": { "method": "updatePlatform", "group": "platforms", - "weight": 192, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -23179,7 +27928,7 @@ "x-appwrite": { "method": "deletePlatform", "group": "platforms", - "weight": 193, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -23247,7 +27996,7 @@ "x-appwrite": { "method": "updateServiceStatus", "group": "projects", - "weight": 161, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -23348,7 +28097,7 @@ "x-appwrite": { "method": "updateServiceStatusAll", "group": "projects", - "weight": 162, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -23426,7 +28175,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 194, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -23555,7 +28304,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 195, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -23693,7 +28442,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 160, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -23769,7 +28518,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 197, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -23989,7 +28738,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 199, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -24252,7 +29001,7 @@ "x-appwrite": { "method": "deleteEmailTemplate", "group": "templates", - "weight": 201, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -24472,7 +29221,7 @@ "x-appwrite": { "method": "getSmsTemplate", "group": "templates", - "weight": 196, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -24689,7 +29438,7 @@ "x-appwrite": { "method": "updateSmsTemplate", "group": "templates", - "weight": 198, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -24924,7 +29673,7 @@ "x-appwrite": { "method": "deleteSmsTemplate", "group": "templates", - "weight": 200, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -25141,7 +29890,7 @@ "x-appwrite": { "method": "listWebhooks", "group": "webhooks", - "weight": 178, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -25199,7 +29948,7 @@ "x-appwrite": { "method": "createWebhook", "group": "webhooks", - "weight": 177, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -25317,7 +30066,7 @@ "x-appwrite": { "method": "getWebhook", "group": "webhooks", - "weight": 179, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -25383,7 +30132,7 @@ "x-appwrite": { "method": "updateWebhook", "group": "webhooks", - "weight": 180, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -25504,7 +30253,7 @@ "x-appwrite": { "method": "deleteWebhook", "group": "webhooks", - "weight": 182, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -25572,7 +30321,7 @@ "x-appwrite": { "method": "updateWebhookSignature", "group": "webhooks", - "weight": 181, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -25638,7 +30387,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 294, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -25711,7 +30460,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 435, + "weight": 482, "cookies": false, "type": "", "deprecated": false, @@ -25781,7 +30530,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 437, + "weight": 484, "cookies": false, "type": "", "deprecated": false, @@ -25864,7 +30613,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 438, + "weight": 485, "cookies": false, "type": "", "deprecated": false, @@ -25984,7 +30733,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 436, + "weight": 483, "cookies": false, "type": "", "deprecated": false, @@ -26065,7 +30814,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 295, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -26118,7 +30867,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 296, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -26178,7 +30927,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 297, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -26236,7 +30985,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -26308,7 +31057,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -26575,7 +31324,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -26624,7 +31373,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -26674,7 +31423,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 429, + "weight": 476, "cookies": false, "type": "", "deprecated": false, @@ -26768,7 +31517,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 430, + "weight": 477, "cookies": false, "type": "", "deprecated": false, @@ -26826,7 +31575,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 431, + "weight": 478, "cookies": false, "type": "", "deprecated": false, @@ -26896,7 +31645,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -26955,7 +31704,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -27217,7 +31966,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -27278,7 +32027,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -27355,7 +32104,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -27435,7 +32184,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -27535,7 +32284,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -27614,7 +32363,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -27720,7 +32469,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -27817,7 +32566,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -27879,7 +32628,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -27946,7 +32695,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -28032,7 +32781,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -28099,7 +32848,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -28170,7 +32919,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -28234,7 +32983,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -28301,7 +33050,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 432, + "weight": 479, "cookies": false, "type": "", "deprecated": false, @@ -28379,7 +33128,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -28438,7 +33187,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -28528,7 +33277,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -28595,7 +33344,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -28687,7 +33436,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -28754,7 +33503,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -28826,7 +33575,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -28963,7 +33712,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -29022,7 +33771,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -29155,7 +33904,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -29214,7 +33963,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -29297,7 +34046,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -29387,7 +34136,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -29457,7 +34206,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -29546,7 +34295,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -29616,7 +34365,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -29695,7 +34444,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -29902,7 +34651,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -29981,7 +34730,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 222, + "weight": 169, "cookies": false, "type": "", "deprecated": false, @@ -30051,7 +34800,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 223, + "weight": 170, "cookies": false, "type": "", "deprecated": false, @@ -30129,7 +34878,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -30204,7 +34953,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -30294,7 +35043,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -30356,7 +35105,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -30431,7 +35180,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -30493,7 +35242,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 237, + "weight": 184, "cookies": false, "type": "", "deprecated": false, @@ -30563,7 +35312,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -30646,7 +35395,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -30759,7 +35508,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -30829,7 +35578,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -30915,7 +35664,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -30987,7 +35736,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -31080,7 +35829,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -31140,7 +35889,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -31218,7 +35967,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -31298,7 +36047,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -31382,7 +36131,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -31442,7 +36191,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -31513,7 +36262,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -31573,7 +36322,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -31645,7 +36394,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -31740,7 +36489,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -31831,7 +36580,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -31920,7 +36669,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -31989,7 +36738,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -32050,7 +36799,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -32141,7 +36890,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -32232,7 +36981,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -32358,7 +37107,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -32470,7 +37219,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -32580,7 +37329,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 280, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -32650,7 +37399,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -32704,7 +37453,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -32765,7 +37514,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -32844,7 +37593,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -32926,7 +37675,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -33006,7 +37755,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -33077,7 +37826,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -33159,7 +37908,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -33233,7 +37982,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -33305,7 +38054,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -33364,7 +38113,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -33423,7 +38172,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -33482,7 +38231,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -33543,7 +38292,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -33622,7 +38371,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -33701,7 +38450,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -33778,7 +38527,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -33837,7 +38586,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -33914,7 +38663,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -33973,7 +38722,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -34027,7 +38776,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -34083,7 +38832,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -34152,7 +38901,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -34229,7 +38978,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -34301,7 +39050,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -34412,7 +39161,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -34480,7 +39229,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -34570,7 +39319,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -34640,7 +39389,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -34722,7 +39471,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -34801,7 +39550,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -34880,7 +39629,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 284, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -34975,7 +39724,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 285, + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -35056,7 +39805,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 286, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -35139,7 +39888,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 287, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -35205,7 +39954,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 288, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -35271,7 +40020,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 283, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -35354,7 +40103,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 293, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -35438,7 +40187,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 290, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -35509,7 +40258,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 291, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -35562,7 +40311,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 292, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -35674,13 +40423,38 @@ "type": "object", "additionalProperties": true }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "type": "object", + "$ref": "#\/definitions\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35699,13 +40473,38 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35730,7 +40529,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35755,7 +40554,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35774,13 +40573,38 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35805,7 +40629,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35830,7 +40654,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35855,7 +40679,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35880,7 +40704,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35905,7 +40729,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35930,7 +40754,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35955,7 +40779,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -35980,7 +40804,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36005,7 +40829,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36030,7 +40854,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36055,7 +40879,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36080,7 +40904,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of templates documents that matched your query.", + "description": "Total number of templates rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36105,7 +40929,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of installations documents that matched your query.", + "description": "Total number of installations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36130,7 +40954,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworkProviderRepositories documents that matched your query.", + "description": "Total number of frameworkProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36155,7 +40979,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimeProviderRepositories documents that matched your query.", + "description": "Total number of runtimeProviderRepositories rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36180,7 +41004,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of branches documents that matched your query.", + "description": "Total number of branches rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36205,7 +41029,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36230,7 +41054,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36255,7 +41079,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36280,7 +41104,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36305,7 +41129,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of projects documents that matched your query.", + "description": "Total number of projects rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36330,7 +41154,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of webhooks documents that matched your query.", + "description": "Total number of webhooks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36355,7 +41179,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of keys documents that matched your query.", + "description": "Total number of keys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36380,7 +41204,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of devKeys documents that matched your query.", + "description": "Total number of devKeys rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36405,7 +41229,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of platforms documents that matched your query.", + "description": "Total number of platforms rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36430,7 +41254,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36455,7 +41279,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36480,7 +41304,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36505,7 +41329,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36530,7 +41354,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36555,7 +41379,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36580,7 +41404,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of rules documents that matched your query.", + "description": "Total number of rules rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36605,7 +41429,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36630,7 +41454,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36655,7 +41479,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36680,7 +41504,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36705,7 +41529,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36730,7 +41554,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36755,7 +41579,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of migrations documents that matched your query.", + "description": "Total number of migrations rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36780,7 +41604,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -36805,7 +41629,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of contents documents that matched your query.", + "description": "Total number of contents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -37760,6 +42584,904 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -37832,6 +43554,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object", @@ -40741,6 +46592,11 @@ "description": "Whether or not to show user MFA status in the teams membership response.", "x-example": true }, + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true + }, "oAuthProviders": { "type": "array", "description": "List of Auth Providers.", @@ -40967,6 +46823,7 @@ "authMembershipsUserName", "authMembershipsUserEmail", "authMembershipsMfa", + "authInvalidateSessions", "oAuthProviders", "platforms", "webhooks", @@ -41039,7 +46896,10 @@ "items": { "type": "string" }, - "x-example": "database.collections.update" + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] }, "security": { "type": "boolean", @@ -41758,12 +47618,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total databases storage in bytes.", @@ -41800,6 +47672,15 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41809,6 +47690,15 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "An array of the aggregated number of databases storage in bytes per period.", @@ -41841,13 +47731,17 @@ "range", "databasesTotal", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databasesReadsTotal", "databasesWritesTotal", "databases", "collections", + "tables", "documents", + "rows", "storage", "databasesReads", "databasesWrites" @@ -41868,12 +47762,24 @@ "x-example": 0, "format": "int32" }, + "tablesTotal": { + "type": "integer", + "description": "Total aggregated number of tables.", + "x-example": 0, + "format": "int32" + }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents.", "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "storageTotal": { "type": "integer", "description": "Total aggregated number of total storage used in bytes.", @@ -41901,6 +47807,15 @@ }, "x-example": [] }, + "tables": { + "type": "array", + "description": "Aggregated number of tables per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "documents": { "type": "array", "description": "Aggregated number of documents per period.", @@ -41910,6 +47825,15 @@ }, "x-example": [] }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "storage": { "type": "array", "description": "Aggregated storage used in bytes per period.", @@ -41941,17 +47865,52 @@ "required": [ "range", "collectionsTotal", + "tablesTotal", "documentsTotal", + "rowsTotal", "storageTotal", "databaseReadsTotal", "databaseWritesTotal", "collections", + "tables", "documents", + "rows", "storage", "databaseReads", "databaseWrites" ] }, + "usageTable": { + "description": "UsageTable", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of of rows.", + "x-example": 0, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "Aggregated number of rows per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "rowsTotal", + "rows" + ] + }, "usageCollection": { "description": "UsageCollection", "type": "object", @@ -43131,6 +49090,12 @@ "x-example": 0, "format": "int32" }, + "rowsTotal": { + "type": "integer", + "description": "Total aggregated number of rows.", + "x-example": 0, + "format": "int32" + }, "databasesTotal": { "type": "integer", "description": "Total aggregated number of databases.", @@ -43351,6 +49316,7 @@ "required": [ "executionsTotal", "documentsTotal", + "rowsTotal", "databasesTotal", "databasesStorageTotal", "usersTotal", diff --git a/app/config/specs/swagger2-latest-server.json b/app/config/specs/swagger2-latest-server.json index 7c15f9e5ea..215735cdb9 100644 --- a/app/config/specs/swagger2-latest-server.json +++ b/app/config/specs/swagger2-latest-server.json @@ -4215,7 +4215,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 71, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -4288,7 +4288,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 70, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -4371,7 +4371,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 72, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -4431,7 +4431,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 74, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -4510,7 +4510,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 75, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -4570,7 +4570,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 77, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -4628,7 +4628,7 @@ ] }, "post": { - "summary": "Create collection", + "summary": "Create collections", "operationId": "databasesCreateCollection", "consumes": [ "application\/json" @@ -4651,7 +4651,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 76, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -4757,7 +4757,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 78, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -4825,7 +4825,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 80, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -4927,7 +4927,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 81, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -4995,7 +4995,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 92, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -5031,7 +5031,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5077,7 +5077,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 89, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -5113,7 +5113,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -5184,7 +5184,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 101, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5220,7 +5220,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5293,7 +5293,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 90, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -5329,7 +5329,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -5377,7 +5377,7 @@ }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update dateTime attribute", + "summary": "Update datetime attribute", "operationId": "databasesUpdateDatetimeAttribute", "consumes": [ "application\/json" @@ -5400,7 +5400,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 102, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -5436,7 +5436,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5509,7 +5509,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 83, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5545,7 +5545,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5616,7 +5616,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 95, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -5652,7 +5652,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5686,7 +5686,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -5713,7 +5713,7 @@ "tags": [ "databases" ], - "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", "responses": { "202": { "description": "AttributeEnum", @@ -5725,12 +5725,12 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 84, + "weight": 353, "cookies": false, "type": "", "deprecated": false, "demo": "databases\/create-enum-attribute.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5761,7 +5761,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5781,7 +5781,7 @@ }, "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Array of enum values.", "default": null, "x-example": null, "items": { @@ -5842,7 +5842,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 96, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -5878,7 +5878,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -5899,7 +5899,7 @@ "properties": { "elements": { "type": "array", - "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.", + "description": "Updated list of enum values.", "default": null, "x-example": null, "items": { @@ -5921,7 +5921,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -5961,7 +5961,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 88, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -5997,7 +5997,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6023,19 +6023,19 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null }, @@ -6080,7 +6080,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 100, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -6116,7 +6116,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6143,26 +6143,26 @@ }, "min": { "type": "number", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value.", "default": null, "x-example": null }, "max": { "type": "number", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value.", "default": null, "x-example": null }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6201,7 +6201,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 87, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -6237,7 +6237,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6263,19 +6263,19 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -6320,7 +6320,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 99, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -6356,7 +6356,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6383,26 +6383,26 @@ }, "min": { "type": "integer", - "description": "Minimum value to enforce on new documents", + "description": "Minimum value", "default": null, "x-example": null }, "max": { "type": "integer", - "description": "Maximum value to enforce on new documents", + "description": "Maximum value", "default": null, "x-example": null }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6441,7 +6441,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 85, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -6477,7 +6477,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6503,7 +6503,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null }, @@ -6548,7 +6548,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 97, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -6584,7 +6584,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6611,14 +6611,14 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value. Cannot be set when attribute is required.", "default": null, "x-example": null, "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -6657,7 +6657,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 91, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -6693,7 +6693,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -6707,7 +6707,7 @@ "properties": { "relatedCollectionId": { "type": "string", - "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Related Collection ID.", "default": null, "x-example": "" }, @@ -6791,7 +6791,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 82, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -6827,7 +6827,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -6911,7 +6911,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 94, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -6947,7 +6947,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -6987,7 +6987,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7026,7 +7026,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 86, + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -7062,7 +7062,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7133,7 +7133,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 98, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -7169,7 +7169,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7203,7 +7203,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7271,7 +7271,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 93, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -7307,7 +7307,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7341,7 +7341,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 104, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -7377,7 +7377,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7418,7 +7418,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 103, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -7454,7 +7454,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -7488,7 +7488,7 @@ }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null } @@ -7521,7 +7521,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 110, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -7605,7 +7605,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 109, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -7616,7 +7616,6 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", "server" @@ -7626,7 +7625,6 @@ { "name": "createDocument", "auth": { - "Admin": [], "Session": [], "Key": [], "JWT": [] @@ -7762,7 +7760,7 @@ ], "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { - "200": { + "201": { "description": "Documents List", "schema": { "$ref": "#\/definitions\/documentList" @@ -7772,7 +7770,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 118, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -7787,6 +7785,24 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocuments", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n" + } + ], "auth": { "Project": [], "Key": [] @@ -7862,7 +7878,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 117, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -7955,7 +7971,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 120, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -8042,7 +8058,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 111, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -8111,7 +8127,7 @@ ] }, "put": { - "summary": "Upsert document", + "summary": "Create or update a document", "operationId": "databasesUpsertDocument", "consumes": [ "application\/json" @@ -8124,7 +8140,7 @@ ], "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { - "200": { + "201": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -8134,7 +8150,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 114, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -8150,6 +8166,25 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "upsertDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [], "Session": [] @@ -8241,7 +8276,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 113, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -8340,7 +8375,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 119, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -8422,7 +8457,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 116, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -8434,8 +8469,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8447,9 +8480,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8492,7 +8523,7 @@ "properties": { "value": { "type": "number", - "description": "Value to decrement the attribute by. The value must be a number.", + "description": "Value to increment the attribute by. The value must be a number.", "default": 1, "x-example": null }, @@ -8533,7 +8564,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 115, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -8545,8 +8576,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, @@ -8558,9 +8587,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8642,7 +8669,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 106, + "weight": 370, "cookies": false, "type": "", "deprecated": false, @@ -8721,8 +8748,8 @@ }, "x-appwrite": { "method": "createIndex", - "group": "collections", - "weight": 105, + "group": "indexes", + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -8850,7 +8877,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 107, + "weight": 368, "cookies": false, "type": "", "deprecated": false, @@ -8920,7 +8947,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 108, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -8972,6 +8999,4455 @@ ] } }, + "\/databases\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Tables List", + "schema": { + "$ref": "#\/definitions\/tableList" + } + } + }, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 375, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-tables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "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, rowSecurity", + "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" + } + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 371, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "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": { + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "tableId", + "name" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 372, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a table by its unique ID.", + "responses": { + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } + } + }, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 374, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List attributes in the collection.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesCreateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a boolean column.\n", + "responses": { + "202": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "createBooleanColumn", + "group": "columns", + "weight": 381, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesUpdateBooleanColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnBoolean", + "schema": { + "$ref": "#\/definitions\/columnBoolean" + } + } + }, + "x-appwrite": { + "method": "updateBooleanColumn", + "group": "columns", + "weight": 382, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesCreateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a date time column according to the ISO 8601 standard.", + "responses": { + "202": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "createDatetimeColumn", + "group": "columns", + "weight": 383, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesUpdateDatetimeColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "responses": { + "200": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } + } + }, + "x-appwrite": { + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 384, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesCreateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an email column.\n", + "responses": { + "202": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "createEmailColumn", + "group": "columns", + "weight": 385, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesUpdateEmailColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } + } + }, + "x-appwrite": { + "method": "updateEmailColumn", + "group": "columns", + "weight": 386, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesCreateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "responses": { + "202": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "createEnumColumn", + "group": "columns", + "weight": 387, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesUpdateEnumColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnEnum", + "schema": { + "$ref": "#\/definitions\/columnEnum" + } + } + }, + "x-appwrite": { + "method": "updateEnumColumn", + "group": "columns", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "elements", + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesCreateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "createFloatColumn", + "group": "columns", + "weight": 389, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesUpdateFloatColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } + } + }, + "x-appwrite": { + "method": "updateFloatColumn", + "group": "columns", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesCreateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "createIntegerColumn", + "group": "columns", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesUpdateIntegerColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnInteger", + "schema": { + "$ref": "#\/definitions\/columnInteger" + } + } + }, + "x-appwrite": { + "method": "updateIntegerColumn", + "group": "columns", + "weight": 392, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesCreateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create IP address column.\n", + "responses": { + "202": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "createIpColumn", + "group": "columns", + "weight": 393, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesUpdateIpColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } + } + }, + "x-appwrite": { + "method": "updateIpColumn", + "group": "columns", + "weight": 394, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesCreateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "202": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "createRelationshipColumn", + "group": "columns", + "weight": 395, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "default": null, + "x-example": null + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesCreateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a string column.\n", + "responses": { + "202": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "createStringColumn", + "group": "columns", + "weight": 397, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "default": null, + "x-example": 1 + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesUpdateStringColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } + } + }, + "x-appwrite": { + "method": "updateStringColumn", + "group": "columns", + "weight": 398, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-string-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1 + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesCreateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a URL column.\n", + "responses": { + "202": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "createUrlColumn", + "group": "columns", + "weight": 399, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com" + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesUpdateUrlColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnURL", + "schema": { + "$ref": "#\/definitions\/columnUrl" + } + } + }, + "x-appwrite": { + "method": "updateUrlColumn", + "group": "columns", + "weight": 400, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesGetColumn", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get column by ID.", + "responses": { + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + } + } + }, + "x-appwrite": { + "method": "getColumn", + "group": "columns", + "weight": 378, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDeleteColumn", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Deletes a column.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteColumn", + "group": "columns", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesUpdateRelationshipColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "responses": { + "200": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } + } + }, + "x-appwrite": { + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 396, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column 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": null, + "x-enum-keys": [] + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Column Indexes List", + "schema": { + "$ref": "#\/definitions\/columnIndexList" + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 404, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "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" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "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\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 401, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "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" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns 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" + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/columnIndex" + } + } + }, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 402, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "tablesDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 403, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesListRows", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "listRows", + "group": "rows", + "weight": 413, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-rows.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/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" + } + ] + }, + "post": { + "summary": "Create row", + "operationId": "tablesCreateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "createRow", + "group": "rows", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/create-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-row.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, + "methods": [ + { + "name": "createRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + }, + { + "name": "createRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define columns before creating rows.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{}" + }, + "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" + } + }, + "rows": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + ] + }, + "put": { + "summary": "Create or update rows", + "operationId": "tablesUpsertRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "upsertRows", + "group": "rows", + "weight": 410, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-rows.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, + "methods": [ + { + "name": "upsertRows", + "auth": { + "Admin": [], + "Key": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.\n" + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "rows" + ] + } + } + ] + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesUpdateRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDeleteRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 412, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-rows.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "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" + } + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesGetRow", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "getRow", + "group": "rows", + "weight": 406, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-row.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row 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" + } + ] + }, + "put": { + "summary": "Create or update a row", + "operationId": "tablesUpsertRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console.", + "responses": { + "201": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "upsertRow", + "group": "rows", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/upsert-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-row.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, + "methods": [ + { + "name": "upsertRow", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [], + "required": [], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateTable) API or directly from your database console." + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "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" + } + } + } + } + } + ] + }, + "patch": { + "summary": "Update row", + "operationId": "tablesUpdateRow", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "updateRow", + "group": "rows", + "weight": 407, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns 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" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDeleteRow", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tables" + ], + "description": "Delete a row by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteRow", + "group": "rows", + "weight": 411, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-row.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, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDecrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "decrementRowColumn", + "group": "rows", + "weight": 416, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesIncrementRowColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tables" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } + } + }, + "x-appwrite": { + "method": "incrementRowColumn", + "group": "rows", + "weight": 415, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "tables\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-row-column.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, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "default": null, + "x-example": null + } + } + } + } + ] + } + }, "\/functions": { "get": { "summary": "List functions", @@ -8995,7 +13471,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 378, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -9068,7 +13544,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 375, + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -9320,7 +13796,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 380, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -9370,7 +13846,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 381, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -9421,7 +13897,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 376, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -9481,7 +13957,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 377, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -9729,7 +14205,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 379, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -9791,7 +14267,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 384, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -9869,7 +14345,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 385, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -9950,7 +14426,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 382, + "weight": 429, "cookies": false, "type": "upload", "deprecated": false, @@ -10043,7 +14519,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 390, + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -10129,7 +14605,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 387, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -10236,7 +14712,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 388, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -10333,7 +14809,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 383, + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -10396,7 +14872,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 386, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -10464,7 +14940,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 389, + "weight": 436, "cookies": false, "type": "location", "deprecated": false, @@ -10551,7 +15027,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 391, + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -10619,7 +15095,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 394, + "weight": 441, "cookies": false, "type": "", "deprecated": false, @@ -10695,7 +15171,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 392, + "weight": 439, "cookies": false, "type": "", "deprecated": false, @@ -10814,7 +15290,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 393, + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -10881,7 +15357,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 395, + "weight": 442, "cookies": false, "type": "", "deprecated": false, @@ -10949,7 +15425,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 400, + "weight": 447, "cookies": false, "type": "", "deprecated": false, @@ -11009,7 +15485,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 398, + "weight": 445, "cookies": false, "type": "", "deprecated": false, @@ -11100,7 +15576,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 399, + "weight": 446, "cookies": false, "type": "", "deprecated": false, @@ -11168,7 +15644,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 401, + "weight": 448, "cookies": false, "type": "", "deprecated": false, @@ -11261,7 +15737,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 402, + "weight": 449, "cookies": false, "type": "", "deprecated": false, @@ -11331,7 +15807,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 308, + "weight": 255, "cookies": false, "type": "graphql", "deprecated": false, @@ -11407,7 +15883,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 307, + "weight": 254, "cookies": false, "type": "graphql", "deprecated": false, @@ -11481,7 +15957,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 132, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -11531,7 +16007,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 153, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -11581,7 +16057,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 135, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -11631,7 +16107,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 140, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -11690,7 +16166,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 134, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -11740,7 +16216,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 136, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -11790,7 +16266,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 142, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -11851,7 +16327,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 141, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -11912,7 +16388,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 143, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -11982,7 +16458,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 144, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -12043,7 +16519,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 154, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -12128,7 +16604,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 148, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -12189,7 +16665,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 139, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -12250,7 +16726,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 145, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -12311,7 +16787,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 146, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -12372,7 +16848,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 147, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -12433,7 +16909,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 149, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -12494,7 +16970,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 150, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -12555,7 +17031,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 138, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -12616,7 +17092,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 152, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -12666,7 +17142,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 151, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -12716,7 +17192,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 137, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -12766,7 +17242,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 124, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -12820,7 +17296,7 @@ "x-appwrite": { "method": "listCodes", "group": null, - "weight": 125, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -12874,7 +17350,7 @@ "x-appwrite": { "method": "listContinents", "group": null, - "weight": 129, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -12928,7 +17404,7 @@ "x-appwrite": { "method": "listCountries", "group": null, - "weight": 126, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -12982,7 +17458,7 @@ "x-appwrite": { "method": "listCountriesEU", "group": null, - "weight": 127, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -13036,7 +17512,7 @@ "x-appwrite": { "method": "listCountriesPhones", "group": null, - "weight": 128, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -13090,7 +17566,7 @@ "x-appwrite": { "method": "listCurrencies", "group": null, - "weight": 130, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -13144,7 +17620,7 @@ "x-appwrite": { "method": "listLanguages", "group": null, - "weight": 131, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -13198,7 +17674,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 362, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -13274,7 +17750,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 359, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -13433,7 +17909,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 366, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -13589,7 +18065,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 361, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -13785,7 +18261,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 368, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -13980,7 +18456,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 360, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -14099,7 +18575,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 367, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -14214,7 +18690,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 365, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -14270,7 +18746,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 369, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -14331,7 +18807,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 363, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -14404,7 +18880,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 364, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -14477,7 +18953,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 334, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -14553,7 +19029,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 333, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -14669,7 +19145,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 346, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -14783,7 +19259,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 332, + "weight": 279, "cookies": false, "type": "", "deprecated": false, @@ -14875,7 +19351,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 345, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -14965,7 +19441,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 324, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -15093,7 +19569,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 337, + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -15219,7 +19695,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 327, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -15323,7 +19799,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 340, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -15425,7 +19901,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 325, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -15541,7 +20017,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 338, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -15655,7 +20131,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 326, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -15815,7 +20291,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 339, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -15972,7 +20448,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 328, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -16076,7 +20552,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 341, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -16178,7 +20654,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 329, + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -16282,7 +20758,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 342, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -16384,7 +20860,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 330, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -16488,7 +20964,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 343, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -16590,7 +21066,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 331, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -16694,7 +21170,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 344, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -16794,7 +21270,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 336, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -16850,7 +21326,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 347, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -16911,7 +21387,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 335, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -16984,7 +21460,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 356, + "weight": 303, "cookies": false, "type": "", "deprecated": false, @@ -17057,7 +21533,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 349, + "weight": 296, "cookies": false, "type": "", "deprecated": false, @@ -17131,7 +21607,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 348, + "weight": 295, "cookies": false, "type": "", "deprecated": false, @@ -17220,7 +21696,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 351, + "weight": 298, "cookies": false, "type": "", "deprecated": false, @@ -17281,7 +21757,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 352, + "weight": 299, "cookies": false, "type": "", "deprecated": false, @@ -17361,7 +21837,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 353, + "weight": 300, "cookies": false, "type": "", "deprecated": false, @@ -17422,7 +21898,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 350, + "weight": 297, "cookies": false, "type": "", "deprecated": false, @@ -17495,7 +21971,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 355, + "weight": 302, "cookies": false, "type": "", "deprecated": false, @@ -17577,7 +22053,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 354, + "weight": 301, "cookies": false, "type": "", "deprecated": false, @@ -17667,7 +22143,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 357, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -17731,7 +22207,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 358, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -17804,7 +22280,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 407, + "weight": 454, "cookies": false, "type": "", "deprecated": false, @@ -17877,7 +22353,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 405, + "weight": 452, "cookies": false, "type": "", "deprecated": false, @@ -18145,7 +22621,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 410, + "weight": 457, "cookies": false, "type": "", "deprecated": false, @@ -18195,7 +22671,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 433, + "weight": 480, "cookies": false, "type": "", "deprecated": false, @@ -18246,7 +22722,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 406, + "weight": 453, "cookies": false, "type": "", "deprecated": false, @@ -18306,7 +22782,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 408, + "weight": 455, "cookies": false, "type": "", "deprecated": false, @@ -18569,7 +23045,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 409, + "weight": 456, "cookies": false, "type": "", "deprecated": false, @@ -18631,7 +23107,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 416, + "weight": 463, "cookies": false, "type": "", "deprecated": false, @@ -18709,7 +23185,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 415, + "weight": 462, "cookies": false, "type": "", "deprecated": false, @@ -18790,7 +23266,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 411, + "weight": 458, "cookies": false, "type": "upload", "deprecated": false, @@ -18891,7 +23367,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 419, + "weight": 466, "cookies": false, "type": "", "deprecated": false, @@ -18971,7 +23447,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 412, + "weight": 459, "cookies": false, "type": "", "deprecated": false, @@ -19078,7 +23554,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 413, + "weight": 460, "cookies": false, "type": "", "deprecated": false, @@ -19176,7 +23652,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 414, + "weight": 461, "cookies": false, "type": "", "deprecated": false, @@ -19239,7 +23715,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 417, + "weight": 464, "cookies": false, "type": "", "deprecated": false, @@ -19307,7 +23783,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 418, + "weight": 465, "cookies": false, "type": "location", "deprecated": false, @@ -19394,7 +23870,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 420, + "weight": 467, "cookies": false, "type": "", "deprecated": false, @@ -19462,7 +23938,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 422, + "weight": 469, "cookies": false, "type": "", "deprecated": false, @@ -19534,7 +24010,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 421, + "weight": 468, "cookies": false, "type": "", "deprecated": false, @@ -19599,7 +24075,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 423, + "weight": 470, "cookies": false, "type": "", "deprecated": false, @@ -19667,7 +24143,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 426, + "weight": 473, "cookies": false, "type": "", "deprecated": false, @@ -19727,7 +24203,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 424, + "weight": 471, "cookies": false, "type": "", "deprecated": false, @@ -19818,7 +24294,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 425, + "weight": 472, "cookies": false, "type": "", "deprecated": false, @@ -19886,7 +24362,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 427, + "weight": 474, "cookies": false, "type": "", "deprecated": false, @@ -19979,7 +24455,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 428, + "weight": 475, "cookies": false, "type": "", "deprecated": false, @@ -20047,7 +24523,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 209, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -20120,7 +24596,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 208, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -20258,7 +24734,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 210, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -20318,7 +24794,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 211, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -20452,7 +24928,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 212, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -20512,7 +24988,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 214, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -20597,7 +25073,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 213, + "weight": 160, "cookies": false, "type": "upload", "deprecated": false, @@ -20689,7 +25165,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 215, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -20761,7 +25237,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 220, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -20852,7 +25328,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 221, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -20924,7 +25400,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 217, + "weight": 164, "cookies": false, "type": "location", "deprecated": false, @@ -21005,7 +25481,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 216, + "weight": 163, "cookies": false, "type": "location", "deprecated": false, @@ -21214,7 +25690,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 218, + "weight": 165, "cookies": false, "type": "location", "deprecated": false, @@ -21295,7 +25771,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 225, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -21372,7 +25848,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 224, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -21464,7 +25940,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 226, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -21528,7 +26004,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 228, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -21605,7 +26081,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 230, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -21669,7 +26145,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 232, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -21754,7 +26230,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 231, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -21869,7 +26345,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 233, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -21941,7 +26417,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 234, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -22029,7 +26505,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 236, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -22103,7 +26579,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 235, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -22198,7 +26674,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 227, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -22260,7 +26736,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 229, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -22340,7 +26816,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 441, + "weight": 488, "cookies": false, "type": "", "deprecated": false, @@ -22421,7 +26897,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 439, + "weight": 486, "cookies": false, "type": "", "deprecated": false, @@ -22506,7 +26982,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 440, + "weight": 487, "cookies": false, "type": "", "deprecated": false, @@ -22567,7 +27043,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 442, + "weight": 489, "cookies": false, "type": "", "deprecated": false, @@ -22639,7 +27115,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 443, + "weight": 490, "cookies": false, "type": "", "deprecated": false, @@ -22700,7 +27176,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 247, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22773,7 +27249,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 238, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -22869,7 +27345,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 241, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -22961,7 +27437,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 239, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -23051,7 +27527,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 255, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -23121,7 +27597,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 278, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -23183,7 +27659,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 240, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -23275,7 +27751,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 243, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -23367,7 +27843,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 244, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -23494,7 +27970,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 245, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -23607,7 +28083,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 242, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -23718,7 +28194,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 248, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23773,7 +28249,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 276, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -23835,7 +28311,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 261, + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -23915,7 +28391,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 279, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -23998,7 +28474,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 257, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -24079,7 +28555,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 253, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -24151,7 +28627,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 252, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -24234,7 +28710,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 266, + "weight": 213, "cookies": false, "type": "", "deprecated": false, @@ -24309,7 +28785,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 271, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -24382,7 +28858,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 267, + "weight": 214, "cookies": false, "type": "", "deprecated": false, @@ -24442,7 +28918,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 268, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -24502,7 +28978,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 270, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -24562,7 +29038,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 269, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -24624,7 +29100,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 259, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -24704,7 +29180,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 260, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -24784,7 +29260,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 262, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -24862,7 +29338,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 249, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -24922,7 +29398,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 264, + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -25000,7 +29476,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 251, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -25060,7 +29536,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 272, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -25115,7 +29591,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 275, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -25172,7 +29648,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 274, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -25242,7 +29718,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 256, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -25320,7 +29796,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 254, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -25393,7 +29869,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 246, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -25505,7 +29981,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 250, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -25574,7 +30050,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 265, + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -25665,7 +30141,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 277, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -25736,7 +30212,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 273, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -25819,7 +30295,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 263, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -25899,7 +30375,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 258, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -26031,13 +30507,38 @@ "type": "object", "additionalProperties": true }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "type": "object", + "$ref": "#\/definitions\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ] + }, "documentList": { "description": "Documents List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents documents that matched your query.", + "description": "Total number of documents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26056,13 +30557,38 @@ "documents" ] }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ] + }, "collectionList": { "description": "Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections documents that matched your query.", + "description": "Total number of collections rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26087,7 +30613,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of databases documents that matched your query.", + "description": "Total number of databases rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26112,7 +30638,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of indexes documents that matched your query.", + "description": "Total number of indexes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26131,13 +30657,38 @@ "indexes" ] }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ] + }, "userList": { "description": "Users List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users documents that matched your query.", + "description": "Total number of users rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26162,7 +30713,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sessions documents that matched your query.", + "description": "Total number of sessions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26187,7 +30738,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of identities documents that matched your query.", + "description": "Total number of identities rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26212,7 +30763,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of logs documents that matched your query.", + "description": "Total number of logs rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26237,7 +30788,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of files documents that matched your query.", + "description": "Total number of files rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26262,7 +30813,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of buckets documents that matched your query.", + "description": "Total number of buckets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26287,7 +30838,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of tokens documents that matched your query.", + "description": "Total number of tokens rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26312,7 +30863,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of teams documents that matched your query.", + "description": "Total number of teams rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26337,7 +30888,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of memberships documents that matched your query.", + "description": "Total number of memberships rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26362,7 +30913,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of sites documents that matched your query.", + "description": "Total number of sites rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26387,7 +30938,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of functions documents that matched your query.", + "description": "Total number of functions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26412,7 +30963,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of frameworks documents that matched your query.", + "description": "Total number of frameworks rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26437,7 +30988,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of runtimes documents that matched your query.", + "description": "Total number of runtimes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26462,7 +31013,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of deployments documents that matched your query.", + "description": "Total number of deployments rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26487,7 +31038,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of executions documents that matched your query.", + "description": "Total number of executions rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26512,7 +31063,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of countries documents that matched your query.", + "description": "Total number of countries rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26537,7 +31088,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of continents documents that matched your query.", + "description": "Total number of continents rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26562,7 +31113,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of languages documents that matched your query.", + "description": "Total number of languages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26587,7 +31138,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of currencies documents that matched your query.", + "description": "Total number of currencies rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26612,7 +31163,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of phones documents that matched your query.", + "description": "Total number of phones rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26637,7 +31188,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of variables documents that matched your query.", + "description": "Total number of variables rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26662,7 +31213,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of localeCodes documents that matched your query.", + "description": "Total number of localeCodes rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26687,7 +31238,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of providers documents that matched your query.", + "description": "Total number of providers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26712,7 +31263,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of messages documents that matched your query.", + "description": "Total number of messages rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26737,7 +31288,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of topics documents that matched your query.", + "description": "Total number of topics rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26762,7 +31313,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of subscribers documents that matched your query.", + "description": "Total number of subscribers rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26787,7 +31338,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of targets documents that matched your query.", + "description": "Total number of targets rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -26812,7 +31363,7 @@ "properties": { "total": { "type": "integer", - "description": "Total number of specifications documents that matched your query.", + "description": "Total number of specifications rows that matched your query.", "x-example": 5, "format": "int32" }, @@ -27767,6 +32318,904 @@ "side" ] }, + "table": { + "description": "Table", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { + "type": "boolean", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "rowSecurity": { + "type": "boolean", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes" + ] + }, + "columnList": { + "description": "Columns List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" + }, + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "columns" + ] + }, + "columnString": { + "description": "ColumnString", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ] + }, + "columnInteger": { + "description": "ColumnInteger", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int32", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnFloat": { + "description": "ColumnFloat", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "percentageCompleted" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnBoolean": { + "description": "ColumnBoolean", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ] + }, + "columnEmail": { + "description": "ColumnEmail", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "userEmail" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnEnum": { + "description": "ColumnEnum", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "status" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" + ] + }, + "columnIp": { + "description": "ColumnIP", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "ipAddress" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnUrl": { + "description": "ColumnURL", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "githubUrl" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnDatetime": { + "description": "ColumnDatetime", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "birthDay" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" + ] + }, + "columnRelationship": { + "description": "ColumnRelationship", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" + ] + }, "index": { "description": "Index", "type": "object", @@ -27839,6 +33288,135 @@ "$updatedAt" ] }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "key", + "type", + "status", + "error", + "columns", + "lengths", + "$createdAt", + "$updatedAt" + ] + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "integer", + "description": "Row automatically incrementing ID.", + "x-example": 1, + "format": "int32" + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e" + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e" + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ] + }, "document": { "description": "Document", "type": "object",