From 32e18f75aff7b9e352a76ebe7d2bd2d59fe25a5a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 9 Apr 2026 09:23:51 +0000 Subject: [PATCH] chore: update API specs and SDK examples --- specs/latest/open-api3-latest-client.json | 222 +- specs/latest/open-api3-latest-console.json | 8913 +++++++++++++------- specs/latest/open-api3-latest-server.json | 5219 ++++++++++-- specs/latest/swagger2-latest-client.json | 217 +- specs/latest/swagger2-latest-console.json | 8138 ++++++++++++------ specs/latest/swagger2-latest-server.json | 5457 ++++++++++-- 6 files changed, 20756 insertions(+), 7410 deletions(-) diff --git a/specs/latest/open-api3-latest-client.json b/specs/latest/open-api3-latest-client.json index 39b28896..f80e1681 100644 --- a/specs/latest/open-api3-latest-client.json +++ b/specs/latest/open-api3-latest-client.json @@ -555,7 +555,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 213, + "weight": 205, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -627,7 +627,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 215, + "weight": 207, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -751,7 +751,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 216, + "weight": 208, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -891,7 +891,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 217, + "weight": 209, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1015,7 +1015,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 221, + "weight": 213, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1149,7 +1149,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 222, + "weight": 214, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1287,7 +1287,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 214, + "weight": 206, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1388,7 +1388,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 220, + "weight": 212, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1487,7 +1487,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 218, + "weight": 210, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1586,7 +1586,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 219, + "weight": 211, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2540,7 +2540,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -2580,6 +2580,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -3472,7 +3473,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -3512,6 +3513,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -4051,7 +4053,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 224, + "weight": 216, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4179,7 +4181,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 223, + "weight": 215, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4313,7 +4315,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 227, + "weight": 219, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4373,7 +4375,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 225, + "weight": 217, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4863,7 +4865,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 226, + "weight": 218, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4947,7 +4949,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 229, + "weight": 221, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5041,7 +5043,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 228, + "weight": 220, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5135,7 +5137,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 230, + "weight": 222, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5888,7 +5890,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 306, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -5955,7 +5957,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 302, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6026,7 +6028,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 303, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6090,7 +6092,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 304, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6168,7 +6170,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 305, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6234,7 +6236,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 307, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6319,7 +6321,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 257, + "weight": 665, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6408,7 +6410,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "schema": { "type": "integer", @@ -6443,7 +6445,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 249, + "weight": 657, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6604,7 +6606,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 250, + "weight": 658, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6715,7 +6717,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 253, + "weight": 661, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6870,7 +6872,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 251, + "weight": 659, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -6982,7 +6984,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 255, + "weight": 663, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7089,7 +7091,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 260, + "weight": 668, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7218,7 +7220,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 259, + "weight": 667, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7347,7 +7349,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 415, + "weight": 827, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -7414,7 +7416,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 411, + "weight": 823, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -7485,7 +7487,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 412, + "weight": 824, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -7549,7 +7551,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 413, + "weight": 825, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -7627,7 +7629,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 414, + "weight": 826, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -7693,7 +7695,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 416, + "weight": 828, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -7777,7 +7779,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 407, + "weight": 819, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -7897,7 +7899,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 399, + "weight": 811, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -8074,7 +8076,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 400, + "weight": 812, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -8181,7 +8183,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 403, + "weight": 815, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -8326,7 +8328,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 401, + "weight": 813, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -8432,7 +8434,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 405, + "weight": 817, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -8534,7 +8536,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 410, + "weight": 822, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -8657,7 +8659,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 409, + "weight": 821, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -8780,7 +8782,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 484, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -8867,7 +8869,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 482, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -8985,7 +8987,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 483, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -9060,7 +9062,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 150, + "weight": 140, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -9114,7 +9116,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 149, + "weight": 139, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -9600,7 +9602,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 197, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -9684,7 +9686,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 201, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -9760,7 +9762,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 594, + "weight": 589, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -9859,7 +9861,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 808, + "weight": 1077, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -9961,7 +9963,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 593, + "weight": 588, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -10035,7 +10037,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 595, + "weight": 590, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -10127,7 +10129,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 596, + "weight": 591, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -10196,7 +10198,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 598, + "weight": 593, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -10276,7 +10278,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 597, + "weight": 592, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -10506,7 +10508,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 599, + "weight": 594, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -10593,7 +10595,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 379, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -10663,7 +10665,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 375, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -10737,7 +10739,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 376, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -10804,7 +10806,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 377, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -10885,7 +10887,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 378, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -10954,7 +10956,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 380, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -11042,7 +11044,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 371, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -11130,7 +11132,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "schema": { "type": "integer", @@ -11165,7 +11167,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 363, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -11321,7 +11323,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 364, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -11431,7 +11433,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 367, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -11581,7 +11583,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 365, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -11692,7 +11694,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 369, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -11798,7 +11800,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 374, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -11926,7 +11928,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 373, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -12054,7 +12056,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 570, + "weight": 565, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -12143,7 +12145,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 568, + "weight": 563, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -12230,7 +12232,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 569, + "weight": 564, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -12294,7 +12296,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 572, + "weight": 567, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -12370,7 +12372,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 571, + "weight": 566, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -12436,7 +12438,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 577, + "weight": 572, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -12535,7 +12537,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 575, + "weight": 570, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -12651,7 +12653,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 576, + "weight": 571, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -12725,7 +12727,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 578, + "weight": 573, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -12814,7 +12816,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 809, + "weight": 1078, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -12890,7 +12892,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 580, + "weight": 575, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -12990,7 +12992,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 573, + "weight": 568, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -13053,7 +13055,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 574, + "weight": 569, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -13137,7 +13139,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 450, + "weight": 862, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -13204,7 +13206,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 446, + "weight": 858, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -13275,7 +13277,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 447, + "weight": 859, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -13339,7 +13341,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 448, + "weight": 860, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -13417,7 +13419,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 449, + "weight": 861, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -13483,7 +13485,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 451, + "weight": 863, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -13568,7 +13570,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 439, + "weight": 851, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -13688,7 +13690,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 435, + "weight": 847, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -13838,7 +13840,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 438, + "weight": 850, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -13945,7 +13947,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 437, + "weight": 849, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -14090,7 +14092,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 436, + "weight": 848, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -14196,7 +14198,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 440, + "weight": 852, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -15017,6 +15019,11 @@ "description": "API mode when event triggered.", "x-example": "admin" }, + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" + }, "ip": { "type": "string", "description": "IP session in use when the session was created.", @@ -15104,6 +15111,7 @@ "userEmail", "userName", "mode", + "userType", "ip", "time", "osCode", @@ -15127,6 +15135,7 @@ "userEmail": "john@appwrite.io", "userName": "John Doe", "mode": "admin", + "userType": "user", "ip": "127.0.0.1", "time": "2020-10-15T06:38:00.000+00:00", "osCode": "Mac", @@ -17020,7 +17029,10 @@ "type": "apiKey", "name": "X-Appwrite-JWT", "description": "Your secret JSON Web Token", - "in": "header" + "in": "header", + "x-appwrite": { + "demo": "" + } }, "Locale": { "type": "apiKey", diff --git a/specs/latest/open-api3-latest-console.json b/specs/latest/open-api3-latest-console.json index f6f24388..9c3f30df 100644 --- a/specs/latest/open-api3-latest-console.json +++ b/specs/latest/open-api3-latest-console.json @@ -227,7 +227,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 794, + "weight": 1036, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -289,7 +289,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 792, + "weight": 1034, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -384,7 +384,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 793, + "weight": 1035, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -443,7 +443,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 795, + "weight": 1037, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -541,7 +541,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 796, + "weight": 1038, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -602,7 +602,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 798, + "weight": 1040, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -877,7 +877,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 797, + "weight": 1039, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -1010,7 +1010,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 780, + "weight": 1022, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1069,7 +1069,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 781, + "weight": 1023, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1120,7 +1120,8 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -1158,7 +1159,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 784, + "weight": 1026, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1216,7 +1217,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 783, + "weight": 1025, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1279,7 +1280,8 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -1308,7 +1310,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 782, + "weight": 1024, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1446,7 +1448,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 213, + "weight": 205, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1517,7 +1519,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 215, + "weight": 207, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1640,7 +1642,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 216, + "weight": 208, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1779,7 +1781,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 217, + "weight": 209, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1902,7 +1904,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 221, + "weight": 213, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2035,7 +2037,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 222, + "weight": 214, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2172,7 +2174,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 214, + "weight": 206, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2272,7 +2274,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 220, + "weight": 212, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2370,7 +2372,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 218, + "weight": 210, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2468,7 +2470,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 219, + "weight": 211, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2716,7 +2718,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 787, + "weight": 1029, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -2778,7 +2780,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 785, + "weight": 1027, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -2827,7 +2829,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 786, + "weight": 1028, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -2886,7 +2888,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 788, + "weight": 1030, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -2970,7 +2972,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 791, + "weight": 1033, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3031,7 +3033,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 789, + "weight": 1031, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3123,7 +3125,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 790, + "weight": 1032, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -3876,7 +3878,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -3916,6 +3918,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -4796,7 +4799,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -4836,6 +4839,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -5377,7 +5381,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 806, + "weight": 1075, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5440,7 +5444,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 807, + "weight": 1076, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5496,7 +5500,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 224, + "weight": 216, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5624,7 +5628,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 223, + "weight": 215, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -5758,7 +5762,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 227, + "weight": 219, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -5818,7 +5822,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 225, + "weight": 217, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6308,7 +6312,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 226, + "weight": 218, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6392,7 +6396,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 229, + "weight": 221, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6486,7 +6490,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 228, + "weight": 220, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6580,7 +6584,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 230, + "weight": 222, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7333,7 +7337,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 774, + "weight": 1016, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7397,7 +7401,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 775, + "weight": 1017, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7486,7 +7490,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 773, + "weight": 1015, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7540,7 +7544,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 776, + "weight": 1018, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7603,7 +7607,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 769, + "weight": 1011, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7667,7 +7671,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 770, + "weight": 1012, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -7785,7 +7789,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 768, + "weight": 1010, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -7846,7 +7850,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 771, + "weight": 1013, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -7935,7 +7939,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 772, + "weight": 1014, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -7998,7 +8002,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 779, + "weight": 1021, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8097,7 +8101,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 778, + "weight": 1020, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8163,7 +8167,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 777, + "weight": 1019, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8219,7 +8223,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 550, + "weight": 545, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8287,7 +8291,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 640, + "weight": 876, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8348,7 +8352,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 637, + "weight": 873, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8409,7 +8413,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 635, + "weight": 871, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8477,7 +8481,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 636, + "weight": 872, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8538,7 +8542,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 638, + "weight": 874, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8599,7 +8603,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 639, + "weight": 875, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8660,7 +8664,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 634, + "weight": 870, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -8702,7 +8706,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 551, + "weight": 546, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -8777,7 +8781,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 641, + "weight": 877, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -8868,7 +8872,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 642, + "weight": 878, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -8973,7 +8977,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 643, + "weight": 879, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9068,7 +9072,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 549, + "weight": 544, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9117,7 +9121,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 238, + "weight": 646, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9236,7 +9240,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 234, + "weight": 642, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9353,7 +9357,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 306, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9420,7 +9424,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 302, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -9491,7 +9495,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 303, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -9555,7 +9559,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 304, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -9633,7 +9637,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 305, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -9699,7 +9703,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 307, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -9784,7 +9788,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 241, + "weight": 649, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -9888,7 +9892,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 235, + "weight": 643, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -9982,7 +9986,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 236, + "weight": 644, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10092,7 +10096,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 237, + "weight": 645, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10187,7 +10191,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 246, + "weight": 654, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10287,7 +10291,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 242, + "weight": 650, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10414,7 +10418,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 243, + "weight": 651, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -10489,7 +10493,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 244, + "weight": 652, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -10569,6 +10573,11 @@ "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false } } } @@ -10592,7 +10601,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 245, + "weight": 653, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -10669,7 +10678,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 263, + "weight": 671, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -10746,21 +10755,21 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -10768,12 +10777,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 264, + "weight": 684, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10784,10 +10793,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [] @@ -10812,7 +10821,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", @@ -10837,10 +10846,25 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -10859,21 +10883,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -10881,12 +10905,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "updateBigIntAttribute", "group": "attributes", - "weight": 265, + "weight": 685, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/update-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10897,10 +10921,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.updateBigIntColumn" }, "auth": { "Project": [] @@ -10925,7 +10949,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -10954,15 +10978,30 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } @@ -10977,21 +11016,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { "post": { - "summary": "Create datetime attribute", - "operationId": "databasesCreateDatetimeAttribute", + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", "tags": [ "databases" ], - "description": "Create a date time attribute according to the ISO 8601 standard.", + "description": "Create a boolean attribute.\n", "responses": { "202": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/attributeBoolean" } } } @@ -10999,12 +11038,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDatetimeAttribute", + "method": "createBooleanAttribute", "group": "attributes", - "weight": 266, + "weight": 672, "cookies": false, "type": "", - "demo": "databases\/create-datetime-attribute.md", + "demo": "databases\/create-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11015,10 +11054,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createDatetimeColumn" + "replaceWith": "tablesDB.createBooleanColumn" }, "auth": { "Project": [] @@ -11043,7 +11082,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -11069,9 +11108,9 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", - "x-example": null, + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, "x-nullable": true }, "array": { @@ -11090,21 +11129,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { "patch": { - "summary": "Update datetime attribute", - "operationId": "databasesUpdateDatetimeAttribute", + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", "tags": [ "databases" ], - "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/attributeBoolean" } } } @@ -11112,12 +11151,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDatetimeAttribute", + "method": "updateBooleanAttribute", "group": "attributes", - "weight": 267, + "weight": 673, "cookies": false, "type": "", - "demo": "databases\/update-datetime-attribute.md", + "demo": "databases\/update-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11128,10 +11167,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateDatetimeColumn" + "replaceWith": "tablesDB.updateBooleanColumn" }, "auth": { "Project": [] @@ -11156,7 +11195,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -11186,9 +11225,9 @@ "x-example": false }, "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": null, + "x-example": false, "x-nullable": true }, "newKey": { @@ -11208,21 +11247,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { "post": { - "summary": "Create email attribute", - "operationId": "databasesCreateEmailAttribute", + "summary": "Create datetime attribute", + "operationId": "databasesCreateDatetimeAttribute", "tags": [ "databases" ], - "description": "Create an email attribute.\n", + "description": "Create a date time attribute according to the ISO 8601 standard.", "responses": { "202": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/attributeDatetime" } } } @@ -11230,12 +11269,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createEmailAttribute", + "method": "createDatetimeAttribute", "group": "attributes", - "weight": 268, + "weight": 674, "cookies": false, "type": "", - "demo": "databases\/create-email-attribute.md", + "demo": "databases\/create-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11246,10 +11285,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEmailColumn" + "replaceWith": "tablesDB.createDatetimeColumn" }, "auth": { "Project": [] @@ -11274,7 +11313,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -11301,9 +11340,9 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", - "format": "email", + "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -11322,21 +11361,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update email attribute", - "operationId": "databasesUpdateEmailAttribute", + "summary": "Update datetime attribute", + "operationId": "databasesUpdateDatetimeAttribute", "tags": [ "databases" ], - "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/attributeDatetime" } } } @@ -11344,12 +11383,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateEmailAttribute", + "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 269, + "weight": 675, "cookies": false, "type": "", - "demo": "databases\/update-email-attribute.md", + "demo": "databases\/update-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11360,10 +11399,243 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateEmailColumn" + "replaceWith": "tablesDB.updateDatetimeColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New attribute key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { + "post": { + "summary": "Create email attribute", + "operationId": "databasesCreateEmailAttribute", + "tags": [ + "databases" + ], + "description": "Create an email attribute.\n", + "responses": { + "202": { + "description": "AttributeEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeEmail" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "createEmailAttribute", + "group": "attributes", + "weight": 676, + "cookies": false, + "type": "", + "demo": "databases\/create-email-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createEmailColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "patch": { + "summary": "Update email attribute", + "operationId": "databasesUpdateEmailAttribute", + "tags": [ + "databases" + ], + "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeEmail", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeEmail" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateEmailAttribute", + "group": "attributes", + "weight": 677, + "cookies": false, + "type": "", + "demo": "databases\/update-email-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateEmailColumn" }, "auth": { "Project": [] @@ -11465,7 +11737,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 270, + "weight": 678, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -11587,7 +11859,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 271, + "weight": 679, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -11714,7 +11986,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 272, + "weight": 680, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -11842,7 +12114,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 273, + "weight": 681, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -11975,7 +12247,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 274, + "weight": 682, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12103,7 +12375,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 275, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12236,7 +12508,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 276, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12349,7 +12621,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 277, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12467,7 +12739,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 278, + "weight": 688, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -12582,7 +12854,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 279, + "weight": 689, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -12706,7 +12978,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 296, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -12820,7 +13092,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 297, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -12934,7 +13206,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 294, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13048,7 +13320,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 295, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13162,7 +13434,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 280, + "weight": 690, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13277,7 +13549,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 281, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13401,7 +13673,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 282, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13516,7 +13788,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 283, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -13640,7 +13912,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -13779,7 +14051,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -13894,7 +14166,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 696, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -14019,7 +14291,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 697, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -14144,7 +14416,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 292, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -14258,7 +14530,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 293, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -14372,7 +14644,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -14486,7 +14758,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -14605,7 +14877,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 290, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -14726,7 +14998,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 291, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -14878,7 +15150,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 261, + "weight": 669, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -14955,7 +15227,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 262, + "weight": 670, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -15041,7 +15313,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 257, + "weight": 665, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15130,7 +15402,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "schema": { "type": "integer", @@ -15165,7 +15437,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 249, + "weight": 657, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15356,7 +15628,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 254, + "weight": 662, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15493,7 +15765,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 252, + "weight": 660, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -15598,7 +15870,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 256, + "weight": 664, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -15700,7 +15972,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 250, + "weight": 658, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -15811,7 +16083,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 253, + "weight": 661, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -15966,7 +16238,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 251, + "weight": 659, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16078,7 +16350,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 255, + "weight": 663, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16185,7 +16457,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 258, + "weight": 666, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16283,7 +16555,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 260, + "weight": 668, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16412,7 +16684,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 259, + "weight": 667, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16541,7 +16813,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 301, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -16640,7 +16912,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 298, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -16781,7 +17053,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 299, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -16858,7 +17130,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 300, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -16944,7 +17216,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 247, + "weight": 655, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17032,7 +17304,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 248, + "weight": 656, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17129,7 +17401,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 239, + "weight": 647, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17237,7 +17509,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 240, + "weight": 648, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17354,7 +17626,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 385, + "weight": 797, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -17440,7 +17712,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 381, + "weight": 793, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -17521,7 +17793,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 415, + "weight": 827, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -17588,7 +17860,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 411, + "weight": 823, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -17659,7 +17931,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 412, + "weight": 824, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -17723,7 +17995,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 413, + "weight": 825, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -17801,7 +18073,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 414, + "weight": 826, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -17867,7 +18139,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 387, + "weight": 799, "cookies": false, "type": "", "demo": "documentsdb\/list-usage.md", @@ -17963,7 +18235,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 382, + "weight": 794, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -18024,7 +18296,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 383, + "weight": 795, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -18102,7 +18374,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 384, + "weight": 796, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -18165,7 +18437,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 392, + "weight": 804, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -18261,7 +18533,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 388, + "weight": 800, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -18384,7 +18656,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 389, + "weight": 801, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -18455,7 +18727,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 390, + "weight": 802, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -18530,6 +18802,11 @@ "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false } }, "required": [ @@ -18556,7 +18833,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 391, + "weight": 803, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -18629,7 +18906,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 407, + "weight": 819, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -18749,7 +19026,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 399, + "weight": 811, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -18924,7 +19201,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 404, + "weight": 816, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -19052,7 +19329,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 402, + "weight": 814, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -19152,7 +19429,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 406, + "weight": 818, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -19249,7 +19526,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 400, + "weight": 812, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -19356,7 +19633,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 403, + "weight": 815, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -19501,7 +19778,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 401, + "weight": 813, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -19607,7 +19884,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 405, + "weight": 817, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -19709,7 +19986,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 408, + "weight": 820, "cookies": false, "type": "", "demo": "documentsdb\/list-document-logs.md", @@ -19803,7 +20080,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 410, + "weight": 822, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -19926,7 +20203,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 409, + "weight": 821, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -20049,7 +20326,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 398, + "weight": 810, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -20144,7 +20421,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 395, + "weight": 807, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -20209,8 +20486,7 @@ "enum": [ "key", "fulltext", - "unique", - "spatial" + "unique" ], "x-enum-name": "DocumentsDBIndexType", "x-enum-keys": [] @@ -20281,7 +20557,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 396, + "weight": 808, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -20354,7 +20630,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 397, + "weight": 809, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -20436,7 +20712,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 393, + "weight": 805, "cookies": false, "type": "", "demo": "documentsdb\/list-collection-logs.md", @@ -20520,7 +20796,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 394, + "weight": 806, "cookies": false, "type": "", "demo": "documentsdb\/get-collection-usage.md", @@ -20613,7 +20889,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 386, + "weight": 798, "cookies": false, "type": "", "demo": "documentsdb\/get-usage.md", @@ -20722,7 +20998,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 649, + "weight": 885, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -20794,7 +21070,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 644, + "weight": 880, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -20867,7 +21143,7 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 647, + "weight": 883, "cookies": false, "type": "", "demo": "domains\/get-price.md", @@ -20956,7 +21232,7 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 694, + "weight": 930, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", @@ -21088,7 +21364,7 @@ "x-appwrite": { "method": "updatePurchase", "group": null, - "weight": 695, + "weight": 931, "cookies": false, "type": "", "demo": "domains\/update-purchase.md", @@ -21167,7 +21443,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 693, + "weight": 929, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -21286,7 +21562,7 @@ "x-appwrite": { "method": "createTransferIn", "group": null, - "weight": 654, + "weight": 890, "cookies": false, "type": "", "demo": "domains\/create-transfer-in.md", @@ -21376,7 +21652,7 @@ "x-appwrite": { "method": "updateTransferIn", "group": null, - "weight": 655, + "weight": 891, "cookies": false, "type": "", "demo": "domains\/update-transfer-in.md", @@ -21455,7 +21731,7 @@ "x-appwrite": { "method": "createTransferOut", "group": null, - "weight": 656, + "weight": 892, "cookies": false, "type": "", "demo": "domains\/create-transfer-out.md", @@ -21528,7 +21804,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 646, + "weight": 882, "cookies": false, "type": "", "demo": "domains\/get.md", @@ -21579,7 +21855,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 645, + "weight": 881, "cookies": false, "type": "", "demo": "domains\/delete.md", @@ -21639,7 +21915,7 @@ "x-appwrite": { "method": "updateAutoRenewal", "group": null, - "weight": 650, + "weight": 886, "cookies": false, "type": "", "demo": "domains\/update-auto-renewal.md", @@ -21718,7 +21994,7 @@ "x-appwrite": { "method": "updateNameservers", "group": null, - "weight": 651, + "weight": 887, "cookies": false, "type": "", "demo": "domains\/update-nameservers.md", @@ -21778,7 +22054,7 @@ "x-appwrite": { "method": "getPresetGoogleWorkspace", "group": null, - "weight": 682, + "weight": 918, "cookies": false, "type": "", "demo": "domains\/get-preset-google-workspace.md", @@ -21836,7 +22112,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 681, + "weight": 917, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -21896,7 +22172,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 692, + "weight": 928, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -21954,7 +22230,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 691, + "weight": 927, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -22014,7 +22290,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 684, + "weight": 920, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -22072,7 +22348,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 683, + "weight": 919, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -22132,7 +22408,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 690, + "weight": 926, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -22190,7 +22466,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 689, + "weight": 925, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -22250,7 +22526,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 688, + "weight": 924, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -22308,7 +22584,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 687, + "weight": 923, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -22368,7 +22644,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 686, + "weight": 922, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -22426,7 +22702,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 685, + "weight": 921, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -22486,7 +22762,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 680, + "weight": 916, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -22559,7 +22835,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 658, + "weight": 894, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -22656,7 +22932,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 659, + "weight": 895, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -22763,7 +23039,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 660, + "weight": 896, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -22860,7 +23136,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 661, + "weight": 897, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -22967,7 +23243,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 662, + "weight": 898, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -23064,7 +23340,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 663, + "weight": 899, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -23171,7 +23447,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 664, + "weight": 900, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -23268,7 +23544,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 665, + "weight": 901, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -23375,7 +23651,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 666, + "weight": 902, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -23472,7 +23748,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 667, + "weight": 903, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -23579,7 +23855,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 668, + "weight": 904, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -23676,7 +23952,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 669, + "weight": 905, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -23783,7 +24059,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 670, + "weight": 906, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -23887,7 +24163,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 671, + "weight": 907, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -24001,7 +24277,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 672, + "weight": 908, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -24098,7 +24374,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 673, + "weight": 909, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -24205,7 +24481,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 674, + "weight": 910, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -24323,7 +24599,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 675, + "weight": 911, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -24451,7 +24727,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 676, + "weight": 912, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -24547,7 +24823,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 677, + "weight": 913, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -24654,7 +24930,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 679, + "weight": 915, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -24715,7 +24991,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 678, + "weight": 914, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -24785,7 +25061,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 653, + "weight": 889, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -24864,7 +25140,7 @@ "x-appwrite": { "method": "getTransferStatus", "group": null, - "weight": 657, + "weight": 893, "cookies": false, "type": "", "demo": "domains\/get-transfer-status.md", @@ -24917,7 +25193,7 @@ "x-appwrite": { "method": "getZone", "group": null, - "weight": 648, + "weight": 884, "cookies": false, "type": "", "demo": "domains\/get-zone.md", @@ -24975,7 +25251,7 @@ "x-appwrite": { "method": "updateZone", "group": null, - "weight": 652, + "weight": 888, "cookies": false, "type": "", "demo": "domains\/update-zone.md", @@ -25054,7 +25330,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 468, + "weight": 463, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -25139,7 +25415,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 628, + "weight": 864, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -25235,6 +25511,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -25272,7 +25549,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -25392,6 +25670,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -25483,7 +25765,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 470, + "weight": 465, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -25533,7 +25815,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 471, + "weight": 466, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -25583,7 +25865,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 494, + "weight": 489, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -25666,6 +25948,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -25703,7 +25986,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -25798,7 +26082,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 493, + "weight": 488, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -25858,7 +26142,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 487, + "weight": 482, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -25930,7 +26214,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 466, + "weight": 461, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -25990,7 +26274,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 629, + "weight": 865, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -26093,6 +26377,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -26130,7 +26415,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -26250,6 +26536,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -26331,7 +26621,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 469, + "weight": 464, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -26393,7 +26683,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 474, + "weight": 469, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -26474,7 +26764,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 475, + "weight": 470, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -26569,7 +26859,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 472, + "weight": 467, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -26669,7 +26959,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 480, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -26755,7 +27045,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 477, + "weight": 472, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -26872,7 +27162,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 478, + "weight": 473, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -26970,7 +27260,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 473, + "weight": 468, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -27033,7 +27323,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 476, + "weight": 471, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -27098,7 +27388,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 479, + "weight": 474, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -27189,7 +27479,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 481, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -27261,7 +27551,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 484, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -27348,7 +27638,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 482, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -27466,7 +27756,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 483, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -27532,7 +27822,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 485, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -27604,7 +27894,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 486, + "weight": 481, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -27686,7 +27976,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 490, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -27746,7 +28036,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 630, + "weight": 866, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -27838,7 +28128,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 489, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -27908,7 +28198,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 491, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -28002,7 +28292,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 492, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -28074,7 +28364,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 150, + "weight": 140, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -28128,7 +28418,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 149, + "weight": 139, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -28182,7 +28472,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 495, + "weight": 490, "cookies": false, "type": "", "demo": "health\/get.md", @@ -28233,7 +28523,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 504, + "weight": 499, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -28284,7 +28574,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 498, + "weight": 493, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -28335,7 +28625,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 501, + "weight": 496, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -28397,7 +28687,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 762, + "weight": 1004, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -28472,7 +28762,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 497, + "weight": 492, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -28523,7 +28813,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 499, + "weight": 494, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -28557,7 +28847,7 @@ "tags": [ "health" ], - "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.", + "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.\n", "responses": { "200": { "description": "Health Queue", @@ -28574,7 +28864,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 505, + "weight": 500, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -28638,7 +28928,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 758, + "weight": 1000, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -28702,7 +28992,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 757, + "weight": 999, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -28766,7 +29056,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 509, + "weight": 504, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -28830,7 +29120,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 759, + "weight": 1001, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -28894,7 +29184,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 508, + "weight": 503, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -28958,7 +29248,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 510, + "weight": 505, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -29033,7 +29323,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 511, + "weight": 506, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -29097,7 +29387,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 518, + "weight": 513, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -29188,7 +29478,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 515, + "weight": 510, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -29252,7 +29542,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 507, + "weight": 502, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -29316,7 +29606,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 512, + "weight": 507, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -29380,7 +29670,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 513, + "weight": 508, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -29444,7 +29734,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 514, + "weight": 509, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -29508,7 +29798,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 760, + "weight": 1002, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -29572,7 +29862,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 516, + "weight": 511, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -29636,7 +29926,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 517, + "weight": 512, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -29700,7 +29990,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 761, + "weight": 1003, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -29764,7 +30054,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 506, + "weight": 501, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -29828,7 +30118,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 503, + "weight": 498, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -29879,7 +30169,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 502, + "weight": 497, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -29930,7 +30220,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 500, + "weight": 495, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -30413,7 +30703,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 205, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -30501,7 +30791,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 202, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -30608,7 +30898,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -30647,7 +30938,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 209, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -30762,7 +31053,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "attachments": { @@ -30805,7 +31097,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 204, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -30925,7 +31217,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -30983,7 +31276,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 211, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -31123,7 +31416,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -31181,7 +31475,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 203, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -31324,7 +31618,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -31362,7 +31657,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 210, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -31515,7 +31810,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -31549,7 +31845,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 208, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -31603,7 +31899,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 212, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -31666,7 +31962,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 206, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -31753,7 +32049,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 207, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -31840,7 +32136,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 176, + "weight": 168, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -31928,7 +32224,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 175, + "weight": 167, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -32107,7 +32403,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 189, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -32288,7 +32584,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 174, + "weight": 166, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -32440,7 +32736,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 188, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -32593,7 +32889,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 165, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -32713,7 +33009,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 179, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -32835,7 +33131,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 169, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -32932,7 +33228,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 183, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -33032,7 +33328,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 167, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -33141,7 +33437,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 181, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -33252,7 +33548,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 166, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -33361,7 +33657,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 180, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -33472,7 +33768,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 168, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -33706,7 +34002,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 182, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -33939,7 +34235,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 170, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -34037,7 +34333,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 184, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -34137,7 +34433,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 171, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -34235,7 +34531,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 185, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -34335,7 +34631,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 172, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -34433,7 +34729,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 186, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -34533,7 +34829,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 173, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -34631,7 +34927,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 187, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -34731,7 +35027,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 178, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -34785,7 +35081,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 190, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -34848,7 +35144,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 177, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -34935,7 +35231,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 199, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -35022,7 +35318,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 192, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -35108,7 +35404,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 191, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -35192,7 +35488,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 194, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -35253,7 +35549,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 195, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -35333,7 +35629,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 196, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -35396,7 +35692,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 193, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -35483,7 +35779,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 198, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -35579,7 +35875,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 197, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -35670,7 +35966,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 200, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -35734,7 +36030,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 201, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -35810,7 +36106,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 157, + "weight": 149, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -35896,7 +36192,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 151, + "weight": 141, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -36015,7 +36311,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 159, + "weight": 151, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -36138,7 +36434,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 156, + "weight": 146, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -36253,7 +36549,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 155, + "weight": 145, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -36338,7 +36634,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 152, + "weight": 142, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -36429,7 +36725,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 160, + "weight": 152, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -36492,14 +36788,14 @@ ] } }, - "\/migrations\/nhost": { + "\/migrations\/json\/exports": { "post": { - "summary": "Create NHost migration", - "operationId": "migrationsCreateNHostMigration", + "summary": "Export documents to JSON", + "operationId": "migrationsCreateJSONExport", "tags": [ "migrations" ], - "description": "Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project. ", + "description": "Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.\n", "responses": { "202": { "description": "Migration", @@ -36514,12 +36810,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createNHostMigration", + "method": "createJSONExport", "group": null, - "weight": 154, + "weight": 148, "cookies": false, "type": "", - "demo": "migrations\/create-n-host-migration.md", + "demo": "migrations\/create-json-export.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -36529,7 +36825,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-json-export.md", "auth": { "Project": [] } @@ -36545,74 +36841,41 @@ "schema": { "type": "object", "properties": { - "resources": { - "type": "array", - "description": "List of resources to migrate", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "user", - "database", - "table", - "column", - "index", - "row", - "document", - "attribute", - "collection", - "bucket", - "file" - ], - "x-enum-name": "NHostMigrationResource", - "x-enum-keys": [] - } - }, - "subdomain": { - "type": "string", - "description": "Source's Subdomain", - "x-example": "" - }, - "region": { - "type": "string", - "description": "Source's Region", - "x-example": "" - }, - "adminSecret": { - "type": "string", - "description": "Source's Admin Secret", - "x-example": "" - }, - "database": { + "resourceId": { "type": "string", - "description": "Source's Database Name", - "x-example": "" + "description": "Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.", + "x-example": "" }, - "username": { + "filename": { "type": "string", - "description": "Source's Database Username", - "x-example": "" + "description": "The name of the file to be created for the export, excluding the .json extension.", + "x-example": "" }, - "password": { - "type": "string", - "description": "Source's Database Password", - "x-example": "" + "columns": { + "type": "array", + "description": "List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.", + "x-example": null, + "items": { + "type": "string" + } }, - "port": { - "type": "integer", - "description": "Source's Database Port", + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.", "x-example": null, - "format": "int32" + "items": { + "type": "string" + } + }, + "notify": { + "type": "boolean", + "description": "Set to true to receive an email when the export is complete. Default is true.", + "x-example": false } }, "required": [ - "resources", - "subdomain", - "region", - "adminSecret", - "database", - "username", - "password" + "resourceId", + "filename" ] } } @@ -36620,21 +36883,21 @@ } } }, - "\/migrations\/nhost\/report": { - "get": { - "summary": "Get NHost migration report", - "operationId": "migrationsGetNHostReport", + "\/migrations\/json\/imports": { + "post": { + "summary": "Import documents from a JSON", + "operationId": "migrationsCreateJSONImport", "tags": [ "migrations" ], - "description": "Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. ", + "description": "Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.\n", "responses": { - "200": { - "description": "Migration Report", + "202": { + "description": "Migration", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/migrationReport" + "$ref": "#\/components\/schemas\/migration" } } } @@ -36642,12 +36905,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getNHostReport", + "method": "createJSONImport", "group": null, - "weight": 162, + "weight": 147, "cookies": false, "type": "", - "demo": "migrations\/get-n-host-report.md", + "demo": "migrations\/create-json-import.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -36657,7 +36920,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-json-import.md", "auth": { "Project": [] } @@ -36667,116 +36930,52 @@ "Project": [] } ], - "parameters": [ - { - "name": "resources", - "description": "List of resources to migrate.", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "user", - "database", - "table", - "column", - "index", - "row", - "document", - "attribute", - "collection", - "bucket", - "file" - ], - "x-enum-name": "NHostMigrationResource", - "x-enum-keys": [] + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "bucketId": { + "type": "string", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "x-example": "" + }, + "fileId": { + "type": "string", + "description": "File ID.", + "x-example": "" + }, + "resourceId": { + "type": "string", + "description": "Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.", + "x-example": "" + }, + "internalFile": { + "type": "boolean", + "description": "Is the file stored in an internal bucket?", + "x-example": false + } + }, + "required": [ + "bucketId", + "fileId", + "resourceId" + ] } - }, - "in": "query" - }, - { - "name": "subdomain", - "description": "Source's Subdomain.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "region", - "description": "Source's Region.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "adminSecret", - "description": "Source's Admin Secret.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "database", - "description": "Source's Database Name.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "username", - "description": "Source's Database Username.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "password", - "description": "Source's Database Password.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "port", - "description": "Source's Database Port.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 5432 - }, - "in": "query" + } } - ] + } } }, - "\/migrations\/supabase": { + "\/migrations\/nhost": { "post": { - "summary": "Create Supabase migration", - "operationId": "migrationsCreateSupabaseMigration", + "summary": "Create NHost migration", + "operationId": "migrationsCreateNHostMigration", "tags": [ "migrations" ], - "description": "Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project. ", + "description": "Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project. ", "responses": { "202": { "description": "Migration", @@ -36791,12 +36990,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSupabaseMigration", + "method": "createNHostMigration", "group": null, - "weight": 153, + "weight": 144, "cookies": false, "type": "", - "demo": "migrations\/create-supabase-migration.md", + "demo": "migrations\/create-n-host-migration.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -36806,7 +37005,284 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "resources": { + "type": "array", + "description": "List of resources to migrate", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "user", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ], + "x-enum-name": "NHostMigrationResource", + "x-enum-keys": [] + } + }, + "subdomain": { + "type": "string", + "description": "Source's Subdomain", + "x-example": "" + }, + "region": { + "type": "string", + "description": "Source's Region", + "x-example": "" + }, + "adminSecret": { + "type": "string", + "description": "Source's Admin Secret", + "x-example": "" + }, + "database": { + "type": "string", + "description": "Source's Database Name", + "x-example": "" + }, + "username": { + "type": "string", + "description": "Source's Database Username", + "x-example": "" + }, + "password": { + "type": "string", + "description": "Source's Database Password", + "x-example": "" + }, + "port": { + "type": "integer", + "description": "Source's Database Port", + "x-example": null, + "format": "int32" + } + }, + "required": [ + "resources", + "subdomain", + "region", + "adminSecret", + "database", + "username", + "password" + ] + } + } + } + } + } + }, + "\/migrations\/nhost\/report": { + "get": { + "summary": "Get NHost migration report", + "operationId": "migrationsGetNHostReport", + "tags": [ + "migrations" + ], + "description": "Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. ", + "responses": { + "200": { + "description": "Migration Report", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/migrationReport" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getNHostReport", + "group": null, + "weight": 154, + "cookies": false, + "type": "", + "demo": "migrations\/get-n-host-report.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "migrations.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "resources", + "description": "List of resources to migrate.", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "user", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ], + "x-enum-name": "NHostMigrationResource", + "x-enum-keys": [] + } + }, + "in": "query" + }, + { + "name": "subdomain", + "description": "Source's Subdomain.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "region", + "description": "Source's Region.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "adminSecret", + "description": "Source's Admin Secret.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "database", + "description": "Source's Database Name.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "username", + "description": "Source's Database Username.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "password", + "description": "Source's Database Password.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "port", + "description": "Source's Database Port.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 5432 + }, + "in": "query" + } + ] + } + }, + "\/migrations\/supabase": { + "post": { + "summary": "Create Supabase migration", + "operationId": "migrationsCreateSupabaseMigration", + "tags": [ + "migrations" + ], + "description": "Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project. ", + "responses": { + "202": { + "description": "Migration", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/migration" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSupabaseMigration", + "group": null, + "weight": 143, + "cookies": false, + "type": "", + "demo": "migrations\/create-supabase-migration.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "migrations.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md", "auth": { "Project": [] } @@ -36916,7 +37392,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 161, + "weight": 153, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -37056,7 +37532,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 158, + "weight": 150, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -37115,7 +37591,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 163, + "weight": 155, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -37167,7 +37643,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 164, + "weight": 156, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -37228,7 +37704,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 715, + "weight": 951, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -37308,7 +37784,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 714, + "weight": 950, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -37438,7 +37914,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 748, + "weight": 984, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -37530,7 +38006,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 716, + "weight": 952, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -37567,21 +38043,21 @@ ] } }, - "\/organizations\/{organizationId}\/aggregations": { + "\/organizations\/{organizationId}\/addons": { "get": { - "summary": "List aggregations", - "operationId": "organizationsListAggregations", + "summary": "List addons", + "operationId": "organizationsListAddons", "tags": [ "organizations" ], - "description": "Get a list of all aggregations for an organization.", + "description": "List all billing addons for an organization.\n", "responses": { "200": { - "description": "Aggregation team list", + "description": "Addons list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/aggregationTeamList" + "$ref": "#\/components\/schemas\/addonList" } } } @@ -37589,22 +38065,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listAggregations", + "method": "listAddons", "group": null, - "weight": 731, + "weight": 992, "cookies": false, "type": "", - "demo": "organizations\/list-aggregations.md", + "demo": "organizations\/list-addons.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": "billing.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/list-aggregations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/list-addons.md", "auth": { "Project": [] } @@ -37624,38 +38100,25 @@ "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, from, to", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" } ] } }, - "\/organizations\/{organizationId}\/aggregations\/{aggregationId}": { - "get": { - "summary": "Get aggregation", - "operationId": "organizationsGetAggregation", + "\/organizations\/{organizationId}\/addons\/baa": { + "post": { + "summary": "Create BAA addon", + "operationId": "organizationsCreateBaaAddon", "tags": [ "organizations" ], - "description": "Get a specific aggregation using it's aggregation ID.", + "description": "Create the BAA billing addon for an organization.\n", "responses": { - "200": { - "description": "AggregationTeam", + "201": { + "description": "Addon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/aggregationTeam" + "$ref": "#\/components\/schemas\/addon" } } } @@ -37663,22 +38126,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getAggregation", + "method": "createBaaAddon", "group": null, - "weight": 732, + "weight": 995, "cookies": false, "type": "", - "demo": "organizations\/get-aggregation.md", - "rate-limit": 0, + "demo": "organizations\/create-baa-addon.md", + "rate-limit": 10, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-aggregation.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/create-baa-addon.md", "auth": { "Project": [] } @@ -37698,58 +38161,25 @@ "x-example": "" }, "in": "path" - }, - { - "name": "aggregationId", - "description": "Invoice unique ID", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "limit", - "description": "Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 5 - }, - "in": "query" - }, - { - "name": "offset", - "description": "Offset value. The default value is 0. Use this param to manage pagination.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - }, - "in": "query" } ] } }, - "\/organizations\/{organizationId}\/billing-address": { - "patch": { - "summary": "Set team's billing address", - "operationId": "organizationsSetBillingAddress", + "\/organizations\/{organizationId}\/addons\/{addonId}": { + "get": { + "summary": "Get addon", + "operationId": "organizationsGetAddon", "tags": [ "organizations" ], - "description": "Set a billing address for an organization.", + "description": "Get the details of a billing addon for an organization.\n", "responses": { "200": { - "description": "Organization", + "description": "Addon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/organization" + "$ref": "#\/components\/schemas\/addon" } } } @@ -37757,22 +38187,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "setBillingAddress", + "method": "getAddon", "group": null, - "weight": 724, + "weight": 993, "cookies": false, "type": "", - "demo": "organizations\/set-billing-address.md", + "demo": "organizations\/get-addon.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "billing.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/set-billing-address.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-addon.md", "auth": { "Project": [] } @@ -37792,35 +38222,26 @@ "x-example": "" }, "in": "path" + }, + { + "name": "addonId", + "description": "Addon ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "billingAddressId": { - "type": "string", - "description": "Unique ID of billing address", - "x-example": "" - } - }, - "required": [ - "billingAddressId" - ] - } - } - } - } + ] }, "delete": { - "summary": "Delete team's billing address", - "operationId": "organizationsDeleteBillingAddress", + "summary": "Delete addon", + "operationId": "organizationsDeleteAddon", "tags": [ "organizations" ], - "description": "Delete a team's billing address.", + "description": "Delete a billing addon for an organization.\n", "responses": { "204": { "description": "No content" @@ -37828,13 +38249,13 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteBillingAddress", + "method": "deleteAddon", "group": null, - "weight": 725, + "weight": 996, "cookies": false, "type": "", - "demo": "organizations\/delete-billing-address.md", - "rate-limit": 0, + "demo": "organizations\/delete-addon.md", + "rate-limit": 10, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "billing.write", @@ -37843,7 +38264,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/delete-billing-address.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/delete-addon.md", "auth": { "Project": [] } @@ -37863,25 +38284,35 @@ "x-example": "" }, "in": "path" + }, + { + "name": "addonId", + "description": "Addon ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ] } }, - "\/organizations\/{organizationId}\/billing-addresses\/{billingAddressId}": { - "get": { - "summary": "Get billing address", - "operationId": "organizationsGetBillingAddress", + "\/organizations\/{organizationId}\/addons\/{addonId}\/confirmations": { + "post": { + "summary": "Confirm addon payment after 3DS authentication", + "operationId": "organizationsConfirmAddonPayment", "tags": [ "organizations" ], - "description": "Get a billing address using it's ID.", + "description": "Confirm payment for a billing addon for an organization.\n", "responses": { "200": { - "description": "BillingAddress", + "description": "Addon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/billingAddress" + "$ref": "#\/components\/schemas\/addon" } } } @@ -37889,22 +38320,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getBillingAddress", + "method": "confirmAddonPayment", "group": null, - "weight": 723, + "weight": 997, "cookies": false, "type": "", - "demo": "organizations\/get-billing-address.md", - "rate-limit": 0, + "demo": "organizations\/confirm-addon-payment.md", + "rate-limit": 10, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-billing-address.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/confirm-addon-payment.md", "auth": { "Project": [] } @@ -37926,33 +38357,33 @@ "in": "path" }, { - "name": "billingAddressId", - "description": "Unique ID of billing address", + "name": "addonId", + "description": "Addon ID", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/organizations\/{organizationId}\/billing-email": { - "patch": { - "summary": "Set team's billing email", - "operationId": "organizationsSetBillingEmail", + "\/organizations\/{organizationId}\/addons\/{addon}\/price": { + "get": { + "summary": "Get addon price", + "operationId": "organizationsGetAddonPrice", "tags": [ "organizations" ], - "description": "Set the current billing email for the organization.", + "description": "Get the price details for a billing addon for an organization.\n", "responses": { "200": { - "description": "Organization", + "description": "AddonPrice", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/organization" + "$ref": "#\/components\/schemas\/addonPrice" } } } @@ -37960,22 +38391,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "setBillingEmail", + "method": "getAddonPrice", "group": null, - "weight": 743, + "weight": 994, "cookies": false, "type": "", - "demo": "organizations\/set-billing-email.md", + "demo": "organizations\/get-addon-price.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "billing.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/set-billing-email.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-addon-price.md", "auth": { "Project": [] } @@ -37995,45 +38426,40 @@ "x-example": "" }, "in": "path" + }, + { + "name": "addon", + "description": "Addon key identifier (e.g. baa).", + "required": true, + "schema": { + "type": "string", + "x-example": "baa", + "enum": [ + "baa" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "billingEmail": { - "type": "string", - "description": "Billing email for the organization.", - "x-example": "email@example.com", - "format": "email" - } - }, - "required": [ - "billingEmail" - ] - } - } - } - } + ] } }, - "\/organizations\/{organizationId}\/budget": { - "patch": { - "summary": "Update organization budget", - "operationId": "organizationsUpdateBudget", + "\/organizations\/{organizationId}\/aggregations": { + "get": { + "summary": "List aggregations", + "operationId": "organizationsListAggregations", "tags": [ "organizations" ], - "description": "Update the budget limit for an organization.", + "description": "Get a list of all aggregations for an organization.", "responses": { "200": { - "description": "Organization", + "description": "Aggregation team list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/organization" + "$ref": "#\/components\/schemas\/aggregationTeamList" } } } @@ -38041,22 +38467,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateBudget", + "method": "listAggregations", "group": null, - "weight": 720, + "weight": 967, "cookies": false, "type": "", - "demo": "organizations\/update-budget.md", + "demo": "organizations\/list-aggregations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "teams.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/update-budget.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/list-aggregations.md", "auth": { "Project": [] } @@ -38069,61 +38495,45 @@ "parameters": [ { "name": "organizationId", - "description": "Organization Unique ID", + "description": "Organization 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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, from, to", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "budget": { - "type": "integer", - "description": "Budget limit for additional usage set for the organization", - "x-example": 0, - "format": "int32", - "x-nullable": true - }, - "alerts": { - "type": "array", - "description": "Budget alert limit percentage", - "x-example": null, - "items": { - "type": "integer" - } - } - }, - "required": [ - "budget" - ] - } - } - } - } + ] } }, - "\/organizations\/{organizationId}\/credits": { + "\/organizations\/{organizationId}\/aggregations\/{aggregationId}": { "get": { - "summary": "List credits", - "operationId": "organizationsListCredits", + "summary": "Get aggregation", + "operationId": "organizationsGetAggregation", "tags": [ "organizations" ], - "description": "List all credits for an organization.\n", + "description": "Get a specific aggregation using it's aggregation ID.", "responses": { "200": { - "description": "CreditList", + "description": "AggregationTeam", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/creditList" + "$ref": "#\/components\/schemas\/aggregationTeam" } } } @@ -38131,22 +38541,490 @@ }, "deprecated": false, "x-appwrite": { - "method": "listCredits", + "method": "getAggregation", "group": null, - "weight": 735, + "weight": 968, "cookies": false, "type": "", - "demo": "organizations\/list-credits.md", + "demo": "organizations\/get-aggregation.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.read", + "scope": "teams.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/list-credits.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-aggregation.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "aggregationId", + "description": "Invoice unique ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "limit", + "description": "Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 5 + }, + "in": "query" + }, + { + "name": "offset", + "description": "Offset value. The default value is 0. Use this param to manage pagination.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "in": "query" + } + ] + } + }, + "\/organizations\/{organizationId}\/billing-address": { + "patch": { + "summary": "Set team's billing address", + "operationId": "organizationsSetBillingAddress", + "tags": [ + "organizations" + ], + "description": "Set a billing address for an organization.", + "responses": { + "200": { + "description": "Organization", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/organization" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "setBillingAddress", + "group": null, + "weight": 960, + "cookies": false, + "type": "", + "demo": "organizations\/set-billing-address.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/set-billing-address.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "billingAddressId": { + "type": "string", + "description": "Unique ID of billing address", + "x-example": "" + } + }, + "required": [ + "billingAddressId" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete team's billing address", + "operationId": "organizationsDeleteBillingAddress", + "tags": [ + "organizations" + ], + "description": "Delete a team's billing address.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteBillingAddress", + "group": null, + "weight": 961, + "cookies": false, + "type": "", + "demo": "organizations\/delete-billing-address.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/delete-billing-address.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/organizations\/{organizationId}\/billing-addresses\/{billingAddressId}": { + "get": { + "summary": "Get billing address", + "operationId": "organizationsGetBillingAddress", + "tags": [ + "organizations" + ], + "description": "Get a billing address using it's ID.", + "responses": { + "200": { + "description": "BillingAddress", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/billingAddress" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getBillingAddress", + "group": null, + "weight": 959, + "cookies": false, + "type": "", + "demo": "organizations\/get-billing-address.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-billing-address.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "billingAddressId", + "description": "Unique ID of billing address", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/organizations\/{organizationId}\/billing-email": { + "patch": { + "summary": "Set team's billing email", + "operationId": "organizationsSetBillingEmail", + "tags": [ + "organizations" + ], + "description": "Set the current billing email for the organization.", + "responses": { + "200": { + "description": "Organization", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/organization" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "setBillingEmail", + "group": null, + "weight": 979, + "cookies": false, + "type": "", + "demo": "organizations\/set-billing-email.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/set-billing-email.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "billingEmail": { + "type": "string", + "description": "Billing email for the organization.", + "x-example": "email@example.com", + "format": "email" + } + }, + "required": [ + "billingEmail" + ] + } + } + } + } + } + }, + "\/organizations\/{organizationId}\/budget": { + "patch": { + "summary": "Update organization budget", + "operationId": "organizationsUpdateBudget", + "tags": [ + "organizations" + ], + "description": "Update the budget limit for an organization.", + "responses": { + "200": { + "description": "Organization", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/organization" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateBudget", + "group": null, + "weight": 956, + "cookies": false, + "type": "", + "demo": "organizations\/update-budget.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/update-budget.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization Unique ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "budget": { + "type": "integer", + "description": "Budget limit for additional usage set for the organization", + "x-example": 0, + "format": "int32", + "x-nullable": true + }, + "alerts": { + "type": "array", + "description": "Budget alert limit percentage", + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "budget" + ] + } + } + } + } + } + }, + "\/organizations\/{organizationId}\/credits": { + "get": { + "summary": "List credits", + "operationId": "organizationsListCredits", + "tags": [ + "organizations" + ], + "description": "List all credits for an organization.\n", + "responses": { + "200": { + "description": "CreditList", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/creditList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCredits", + "group": null, + "weight": 971, + "cookies": false, + "type": "", + "demo": "organizations\/list-credits.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/list-credits.md", "auth": { "Project": [] } @@ -38205,7 +39083,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 736, + "weight": 972, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -38285,7 +39163,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 734, + "weight": 970, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -38346,7 +39224,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 733, + "weight": 969, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -38417,7 +39295,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 749, + "weight": 985, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -38478,7 +39356,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 747, + "weight": 983, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -38572,7 +39450,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 750, + "weight": 986, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -38670,7 +39548,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 738, + "weight": 974, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -38744,7 +39622,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 737, + "weight": 973, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -38815,7 +39693,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 741, + "weight": 977, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -38886,7 +39764,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 742, + "weight": 978, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -38976,7 +39854,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 739, + "weight": 975, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -39047,7 +39925,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 740, + "weight": 976, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -39118,7 +39996,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 753, + "weight": 989, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -39187,7 +40065,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 751, + "weight": 987, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -39239,16 +40117,14 @@ "items": { "type": "string", "enum": [ - "platforms.read", - "platforms.write", "projects.read", "projects.write", - "keys.read", - "keys.write", "devKeys.read", "devKeys.write", "domains.read", - "domains.write" + "domains.write", + "keys.read", + "keys.write" ], "x-enum-name": null, "x-enum-keys": [] @@ -39257,7 +40133,8 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -39295,7 +40172,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 755, + "weight": 991, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -39363,7 +40240,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 752, + "weight": 988, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -39425,16 +40302,14 @@ "items": { "type": "string", "enum": [ - "platforms.read", - "platforms.write", "projects.read", "projects.write", - "keys.read", - "keys.write", "devKeys.read", "devKeys.write", "domains.read", - "domains.write" + "domains.write", + "keys.read", + "keys.write" ], "x-enum-name": null, "x-enum-keys": [] @@ -39443,7 +40318,8 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -39472,7 +40348,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 754, + "weight": 990, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -39542,7 +40418,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 727, + "weight": 963, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -39620,7 +40496,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 729, + "weight": 965, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -39681,7 +40557,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 728, + "weight": 964, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -39759,7 +40635,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 730, + "weight": 966, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -39820,7 +40696,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 726, + "weight": 962, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -39891,7 +40767,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 717, + "weight": 953, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -39950,7 +40826,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 718, + "weight": 954, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -40068,7 +40944,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 719, + "weight": 955, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -40129,7 +41005,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 746, + "weight": 982, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -40190,7 +41066,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 745, + "weight": 981, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -40262,7 +41138,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 721, + "weight": 957, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -40342,7 +41218,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 722, + "weight": 958, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -40381,7 +41257,9 @@ "description": "Starting date for the usage", "required": false, "schema": { - "type": "string" + "type": "string", + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00" }, "in": "query" }, @@ -40390,7 +41268,9 @@ "description": "End date for the usage", "required": false, "schema": { - "type": "string" + "type": "string", + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00" }, "in": "query" } @@ -40421,7 +41301,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 744, + "weight": 980, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -40477,21 +41357,21 @@ } } }, - "\/project\/usage": { - "get": { - "summary": "Get project usage stats", - "operationId": "projectGetUsage", + "\/project\/auth\/canonical-emails": { + "patch": { + "summary": "Update project auth canonical emails", + "operationId": "projectUpdateCanonicalEmails", "tags": [ "project" ], - "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", + "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", "responses": { "200": { - "description": "UsageProject", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageProject" + "$ref": "#\/components\/schemas\/project" } } } @@ -40499,88 +41379,206 @@ }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 627, + "method": "updateCanonicalEmails", + "group": "auth", + "weight": 1072, "cookies": false, "type": "", - "demo": "project\/get-usage.md", + "demo": "project\/update-canonical-emails.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "startDate", - "description": "Starting date for the usage", - "required": true, - "schema": { - "type": "string" - }, - "in": "query" - }, + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to require canonical email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/auth\/disposable-emails": { + "patch": { + "summary": "Update project auth disposable emails", + "operationId": "projectUpdateDisposableEmails", + "tags": [ + "project" + ], + "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDisposableEmails", + "group": "auth", + "weight": 1073, + "cookies": false, + "type": "", + "demo": "project\/update-disposable-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "endDate", - "description": "End date for the usage", - "required": true, - "schema": { - "type": "string" - }, - "in": "query" - }, + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/auth\/free-emails": { + "patch": { + "summary": "Update project auth free emails", + "operationId": "projectUpdateFreeEmails", + "tags": [ + "project" + ], + "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateFreeEmails", + "group": "auth", + "weight": 1074, + "cookies": false, + "type": "", + "demo": "project\/update-free-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "period", - "description": "Period used", - "required": false, - "schema": { - "type": "string", - "x-example": "1h", - "enum": [ - "1h", - "1d" - ], - "x-enum-name": "ProjectUsageRange", - "x-enum-keys": [ - "One Hour", - "One Day" - ], - "default": "1d" - }, - "in": "query" + "Project": [], + "Key": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } } }, - "\/project\/variables": { + "\/project\/keys": { "get": { - "summary": "List project variables", - "operationId": "projectListVariables", + "summary": "List project keys", + "operationId": "projectListKeys", "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Get a list of all API keys from the current project.", "responses": { "200": { - "description": "Variables List", + "description": "API Keys List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variableList" + "$ref": "#\/components\/schemas\/keyList" } } } @@ -40588,16 +41586,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 623, + "method": "listKeys", + "group": "keys", + "weight": 1055, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/list-keys.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "keys.read", "platforms": [ "console", "server" @@ -40617,7 +41615,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", + "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: expire, accessedAt, name, scopes", "required": false, "schema": { "type": "array", @@ -40642,19 +41640,19 @@ ] }, "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", + "summary": "Create project key", + "operationId": "projectCreateKey", "tags": [ "project" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", "responses": { "201": { - "description": "Variable", + "description": "Key", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/key" } } } @@ -40662,16 +41660,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 622, + "method": "createKey", + "group": "keys", + "weight": 1054, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/create-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "keys.write", "platforms": [ "console", "server" @@ -40694,31 +41692,115 @@ "schema": { "type": "object", "properties": { - "variableId": { + "keyId": { "type": "string", - "description": "Variable 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": "" + "description": "Key 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": "" }, - "key": { + "name": { "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "description": "Key name. Max length: 128 chars.", + "x-example": "" }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "" + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "x-nullable": true }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } }, "required": [ - "variableId", - "key", - "value" + "keyId", + "name", + "scopes" ] } } @@ -40726,21 +41808,21 @@ } } }, - "\/project\/variables\/{variableId}": { + "\/project\/keys\/{keyId}": { "get": { - "summary": "Get project variable", - "operationId": "projectGetVariable", + "summary": "Get project key", + "operationId": "projectGetKey", "tags": [ "project" ], - "description": "Get a variable by its unique ID. ", + "description": "Get a key by its unique ID. ", "responses": { "200": { - "description": "Variable", + "description": "Key", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/key" } } } @@ -40748,16 +41830,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 624, + "method": "getKey", + "group": "keys", + "weight": 1056, "cookies": false, "type": "", - "demo": "project\/get-variable.md", + "demo": "project\/get-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "keys.read", "platforms": [ "console", "server" @@ -40776,31 +41858,31 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "keyId", + "description": "Key ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, "put": { - "summary": "Update project variable", - "operationId": "projectUpdateVariable", + "summary": "Update project key", + "operationId": "projectUpdateKey", "tags": [ "project" ], - "description": "Update variable by its unique ID.", + "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.", "responses": { "200": { - "description": "Variable", + "description": "Key", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/key" } } } @@ -40808,16 +41890,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 626, + "method": "updateKey", + "group": "keys", + "weight": 1058, "cookies": false, "type": "", - "demo": "project\/update-variable.md", + "demo": "project\/update-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "keys.write", "platforms": [ "console", "server" @@ -40836,12 +41918,12 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "keyId", + "description": "Key ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -40852,37 +41934,122 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "", - "x-nullable": true + "description": "Key name. Max length: 128 chars.", + "x-example": "" }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "", + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, "x-nullable": true }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } - } + }, + "required": [ + "name", + "scopes" + ] } } } } }, "delete": { - "summary": "Delete project variable", - "operationId": "projectDeleteVariable", + "summary": "Delete project key", + "operationId": "projectDeleteKey", "tags": [ "project" ], - "description": "Delete a variable by its unique ID. ", + "description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.", "responses": { "204": { "description": "No content" @@ -40890,16 +42057,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 625, + "method": "deleteKey", + "group": "keys", + "weight": 1057, "cookies": false, "type": "", - "demo": "project\/delete-variable.md", + "demo": "project\/delete-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "keys.write", "platforms": [ "console", "server" @@ -40918,33 +42085,33 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "keyId", + "description": "Key ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/projects": { - "get": { - "summary": "List projects", - "operationId": "projectsList", + "\/project\/labels": { + "put": { + "summary": "Update project labels", + "operationId": "projectUpdateLabels", "tags": [ - "projects" + "project" ], - "description": "Get a list of all projects. You can use the query params to filter your results. ", + "description": "Update the project labels. Labels can be used to easily filter projects in an organization.", "responses": { "200": { - "description": "Projects List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/projectList" + "$ref": "#\/components\/schemas\/project" } } } @@ -40952,18 +42119,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "projects", - "weight": 804, + "method": "updateLabels", + "group": null, + "weight": 1048, "cookies": false, "type": "", - "demo": "projects\/list.md", + "demo": "project\/update-labels.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -40973,13 +42141,86 @@ }, "security": [ { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "labels": { + "type": "array", + "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + }, + "required": [ + "labels" + ] + } + } + } + } + } + }, + "\/project\/platforms": { + "get": { + "summary": "List project platforms", + "operationId": "projectListPlatforms", + "tags": [ + "project" + ], + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "responses": { + "200": { + "description": "Platforms List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listPlatforms", + "group": "platforms", + "weight": 1071, + "cookies": false, + "type": "", + "demo": "project\/list-platforms.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { "Project": [] } + }, + "security": [ + { + "Project": [], + "Key": [] + } ], "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, teamId, labels, search", + "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: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", "required": false, "schema": { "type": "array", @@ -40990,17 +42231,6 @@ }, "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -41013,21 +42243,23 @@ "in": "query" } ] - }, + } + }, + "\/project\/platforms\/android": { "post": { - "summary": "Create project", - "operationId": "projectsCreate", + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", "tags": [ - "projects" + "project" ], - "description": "Create a new project. You can create a maximum of 100 projects per account. ", + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", "responses": { "201": { - "description": "Project", + "description": "Platform Android", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/platformAndroid" } } } @@ -41035,29 +42267,30 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "projects", - "weight": 802, + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1067, "cookies": false, "type": "", - "demo": "projects\/create.md", + "demo": "project\/create-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "requestBody": { @@ -41066,87 +42299,26 @@ "schema": { "type": "object", "properties": { - "projectId": { + "platformId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", - "x-example": null + "description": "Platform 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": "Project name. Max length: 128 chars.", + "description": "Platform name. Max length: 128 chars.", "x-example": "" }, - "teamId": { - "type": "string", - "description": "Team unique ID.", - "x-example": "" - }, - "region": { - "type": "string", - "description": "Project Region.", - "x-example": "fra", - "enum": [ - "fra", - "nyc", - "syd", - "sfo", - "sgp", - "tor" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal Name. Max length: 256 chars.", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal Country. Max length: 256 chars.", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal State. Max length: 256 chars.", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal City. Max length: 256 chars.", - "x-example": "" - }, - "legalAddress": { - "type": "string", - "description": "Project legal Address. Max length: 256 chars.", - "x-example": "" - }, - "legalTaxId": { + "applicationId": { "type": "string", - "description": "Project legal Tax ID. Max length: 256 chars.", - "x-example": "" + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "projectId", + "platformId", "name", - "teamId" + "applicationId" ] } } @@ -41154,21 +42326,21 @@ } } }, - "\/projects\/{projectId}": { - "get": { - "summary": "Get project", - "operationId": "projectsGet", + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", "tags": [ - "projects" + "project" ], - "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", "responses": { "200": { - "description": "Project", + "description": "Platform Android", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/platformAndroid" } } } @@ -41176,58 +42348,86 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "projects", - "weight": 57, + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1062, "cookies": false, "type": "", - "demo": "projects\/get.md", + "demo": "project\/update-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] - }, - "patch": { - "summary": "Update project", - "operationId": "projectsUpdate", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } + } + } + } + } + }, + "\/project\/platforms\/apple": { + "post": { + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", "tags": [ - "projects" + "project" ], - "description": "Update a project by its unique ID.", + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Apple", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/platformApple" } } } @@ -41235,39 +42435,121 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "projects", - "weight": 803, + "method": "createApplePlatform", + "group": "platforms", + "weight": 1066, "cookies": false, "type": "", - "demo": "projects\/update.md", + "demo": "project\/create-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } }, "security": [ { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "bundleIdentifier" + ] + } + } + } + } + } + }, + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", + "tags": [ + "project" + ], + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", + "responses": { + "200": { + "description": "Platform Apple", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformApple" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1061, + "cookies": false, + "type": "", + "demo": "project\/update-apple-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { "Project": [] } + }, + "security": [ + { + "Project": [], + "Key": [] + } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -41280,236 +42562,496 @@ "properties": { "name": { "type": "string", - "description": "Project name. Max length: 128 chars.", + "description": "Platform name. Max length: 128 chars.", "x-example": "" }, - "description": { + "bundleIdentifier": { "type": "string", - "description": "Project description. Max length: 256 chars.", - "x-example": "" - }, - "logo": { + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } + } + } + } + } + }, + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", + "tags": [ + "project" + ], + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Linux", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformLinux" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1069, + "cookies": false, + "type": "", + "demo": "project\/create-linux-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { "type": "string", - "description": "Project logo.", - "x-example": "" + "description": "Platform 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": "" }, - "url": { + "name": { "type": "string", - "description": "Project URL.", - "x-example": "https:\/\/example.com", - "format": "url" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "legalName": { + "packageName": { "type": "string", - "description": "Project legal name. Max length: 256 chars.", - "x-example": "" - }, - "legalCountry": { + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageName" + ] + } + } + } + } + } + }, + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", + "tags": [ + "project" + ], + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", + "responses": { + "200": { + "description": "Platform Linux", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformLinux" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1064, + "cookies": false, + "type": "", + "demo": "project\/update-linux-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "Project legal country. Max length: 256 chars.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "legalState": { + "packageName": { "type": "string", - "description": "Project legal state. Max length: 256 chars.", - "x-example": "" - }, - "legalCity": { + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "packageName" + ] + } + } + } + } + } + }, + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", + "tags": [ + "project" + ], + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Web", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformWeb" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createWebPlatform", + "group": "platforms", + "weight": 1065, + "cookies": false, + "type": "", + "demo": "project\/create-web-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { "type": "string", - "description": "Project legal city. Max length: 256 chars.", - "x-example": "" + "description": "Platform 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": "" }, - "legalAddress": { + "name": { "type": "string", - "description": "Project legal address. Max length: 256 chars.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "legalTaxId": { + "hostname": { "type": "string", - "description": "Project legal tax ID. Max length: 256 chars.", - "x-example": "" + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": null } }, "required": [ + "platformId", "name" ] } } } } - }, - "delete": { - "summary": "Delete project", - "operationId": "projectsDelete", + } + }, + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", "tags": [ - "projects" + "project" ], - "description": "Delete a project by its unique ID.", + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Platform Web", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformWeb" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "projects", - "weight": 73, + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1060, "cookies": false, "type": "", - "demo": "projects\/delete.md", + "demo": "project\/update-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": null + } + }, + "required": [ + "name" + ] + } + } + } + } } }, - "\/projects\/{projectId}\/api": { - "patch": { - "summary": "Update API status", - "operationId": "projectsUpdateApiStatus", + "\/project\/platforms\/windows": { + "post": { + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", "tags": [ - "projects" + "project" ], - "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Windows", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/platformWindows" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateApiStatus", - "group": "projects", - "weight": 60, + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1068, "cookies": false, "type": "", - "demo": "projects\/update-api-status.md", + "demo": "project\/create-windows-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatus" - }, - "methods": [ - { - "name": "updateApiStatus", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "api", - "status" - ], - "required": [ - "projectId", - "api", - "status" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/project" - } - ], - "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", - "demo": "projects\/update-api-status.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatus" + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageIdentifierName" + ] } - }, - { - "name": "updateAPIStatus", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "api", - "status" - ], - "required": [ - "projectId", - "api", - "status" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/project" + } + } + } + } + }, + "\/project\/platforms\/windows\/{platformId}": { + "put": { + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", + "tags": [ + "project" + ], + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", + "responses": { + "200": { + "description": "Platform Windows", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformWindows" } - ], - "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", - "demo": "projects\/update-api-status.md", - "public": true + } } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1063, + "cookies": false, + "type": "", + "demo": "project\/update-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" ], + "packaging": false, + "public": true, "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -41520,27 +43062,20 @@ "schema": { "type": "object", "properties": { - "api": { + "name": { "type": "string", - "description": "API name.", - "x-example": "rest", - "enum": [ - "rest", - "graphql", - "realtime" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "status": { - "type": "boolean", - "description": "API status.", - "x-example": false + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "api", - "status" + "name", + "packageIdentifierName" ] } } @@ -41548,123 +43083,350 @@ } } }, - "\/projects\/{projectId}\/api\/all": { - "patch": { - "summary": "Update all API status", - "operationId": "projectsUpdateApiStatusAll", + "\/project\/platforms\/{platformId}": { + "get": { + "summary": "Get project platform", + "operationId": "projectGetPlatform", "tags": [ - "projects" + "project" ], - "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", "responses": { "200": { - "description": "Project", + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ] } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateApiStatusAll", - "group": "projects", - "weight": 61, + "method": "getPlatform", + "group": "platforms", + "weight": 1070, "cookies": false, "type": "", - "demo": "projects\/update-api-status-all.md", + "demo": "project\/get-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", + "tags": [ + "project" + ], + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deletePlatform", + "group": "platforms", + "weight": 1059, + "cookies": false, + "type": "", + "demo": "project\/delete-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/project\/usage": { + "get": { + "summary": "Get project usage stats", + "operationId": "projectGetUsage", + "tags": [ + "project" + ], + "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", + "responses": { + "200": { + "description": "UsageProject", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageProject" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getUsage", + "group": null, + "weight": 641, + "cookies": false, + "type": "", + "demo": "project\/get-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.read", "platforms": [ "console" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status-all.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatusAll" + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "startDate", + "description": "Starting date for the usage", + "required": true, + "schema": { + "type": "string", + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "in": "query" }, - "methods": [ - { - "name": "updateApiStatusAll", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "status" + { + "name": "endDate", + "description": "End date for the usage", + "required": true, + "schema": { + "type": "string", + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "in": "query" + }, + { + "name": "period", + "description": "Period used", + "required": false, + "schema": { + "type": "string", + "x-example": "1h", + "enum": [ + "1h", + "1d" ], - "required": [ - "projectId", - "status" + "x-enum-name": "ProjectUsageRange", + "x-enum-keys": [ + "One Hour", + "One Day" ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/project" + "default": "1d" + }, + "in": "query" + } + ] + } + }, + "\/project\/variables": { + "get": { + "summary": "List project variables", + "operationId": "projectListVariables", + "tags": [ + "project" + ], + "description": "Get a list of all project environment variables.", + "responses": { + "200": { + "description": "Variables List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variableList" } - ], - "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", - "demo": "projects\/update-api-status-all.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatusAll" } - }, - { - "name": "updateAPIStatusAll", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listVariables", + "group": "variables", + "weight": 1050, + "cookies": false, + "type": "", + "demo": "project\/list-variables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" }, - "parameters": [ - "projectId", - "status" - ], - "required": [ - "projectId", - "status" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/project" + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create project variable", + "operationId": "projectCreateVariable", + "tags": [ + "project" + ], + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "responses": { + "201": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" } - ], - "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", - "demo": "projects\/update-api-status-all.md", - "public": true + } } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createVariable", + "group": "variables", + "weight": 1049, + "cookies": false, + "type": "", + "demo": "project\/create-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" ], + "packaging": false, + "public": true, "auth": { "Project": [] } }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -41673,14 +43435,30 @@ "schema": { "type": "object", "properties": { - "status": { + "variableId": { + "type": "string", + "description": "Variable 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": "" + }, + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "" + }, + "secret": { "type": "boolean", - "description": "API status.", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "x-example": false } }, "required": [ - "status" + "key", + "value" ] } } @@ -41688,21 +43466,21 @@ } } }, - "\/projects\/{projectId}\/auth\/duration": { - "patch": { - "summary": "Update project authentication duration", - "operationId": "projectsUpdateAuthDuration", + "\/project\/variables\/{variableId}": { + "get": { + "summary": "Get project variable", + "operationId": "projectGetVariable", "tags": [ - "projects" + "project" ], - "description": "Update how long sessions created within a project should stay active for.", + "description": "Get a variable by its unique ID. ", "responses": { "200": { - "description": "Project", + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/variable" } } } @@ -41710,80 +43488,59 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthDuration", - "group": "auth", - "weight": 66, + "method": "getVariable", + "group": "variables", + "weight": 1051, "cookies": false, "type": "", - "demo": "projects\/update-auth-duration.md", + "demo": "project\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "duration": { - "type": "integer", - "description": "Project session length in seconds. Max length: 31536000 seconds.", - "x-example": 0, - "format": "int32" - } - }, - "required": [ - "duration" - ] - } - } - } - } - } - }, - "\/projects\/{projectId}\/auth\/limit": { - "patch": { - "summary": "Update project users limit", - "operationId": "projectsUpdateAuthLimit", + ] + }, + "put": { + "summary": "Update project variable", + "operationId": "projectUpdateVariable", "tags": [ - "projects" + "project" ], - "description": "Update the maximum number of users allowed in this project. Set to 0 for unlimited users. ", + "description": "Update variable by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/variable" } } } @@ -41791,39 +43548,40 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthLimit", - "group": "auth", - "weight": 65, + "method": "updateVariable", + "group": "variables", + "weight": 1053, "cookies": false, "type": "", - "demo": "projects\/update-auth-limit.md", + "demo": "project\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -41834,118 +43592,99 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "description": "Set the max number of users allowed in this project. Use 0 for unlimited.", - "x-example": 0, - "format": "int32" + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "x-example": "", + "x-nullable": true + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "limit" - ] + } } } } } - } - }, - "\/projects\/{projectId}\/auth\/max-sessions": { - "patch": { - "summary": "Update project user sessions limit", - "operationId": "projectsUpdateAuthSessionsLimit", + }, + "delete": { + "summary": "Delete project variable", + "operationId": "projectDeleteVariable", "tags": [ - "projects" + "project" ], - "description": "Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.", + "description": "Delete a variable by its unique ID. ", "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthSessionsLimit", - "group": "auth", - "weight": 71, + "method": "deleteVariable", + "group": "variables", + "weight": 1052, "cookies": false, "type": "", - "demo": "projects\/update-auth-sessions-limit.md", + "demo": "project\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10", - "x-example": 1, - "format": "int32" - } - }, - "required": [ - "limit" - ] - } - } - } - } + ] } }, - "\/projects\/{projectId}\/auth\/memberships-privacy": { - "patch": { - "summary": "Update project memberships privacy attributes", - "operationId": "projectsUpdateMembershipsPrivacy", + "\/projects": { + "get": { + "summary": "List projects", + "operationId": "projectsList", "tags": [ "projects" ], - "description": "Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status. ", + "description": "Get a list of all projects. You can use the query params to filter your results. ", "responses": { "200": { - "description": "Project", + "description": "Projects List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/projectList" } } } @@ -41953,22 +43692,21 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipsPrivacy", - "group": "auth", - "weight": 64, + "method": "list", + "group": "projects", + "weight": 1046, "cookies": false, "type": "", - "demo": "projects\/update-memberships-privacy.md", + "demo": "projects\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "projects.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md", "auth": { "Project": [] } @@ -41980,59 +43718,51 @@ ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, teamId, labels, search", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "userName": { - "type": "boolean", - "description": "Set to true to show userName to members of a team.", - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true to show email to members of a team.", - "x-example": false - }, - "mfa": { - "type": "boolean", - "description": "Set to true to show mfa to members of a team.", - "x-example": false - } - }, - "required": [ - "userName", - "userEmail", - "mfa" - ] - } - } + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } - } - } - }, - "\/projects\/{projectId}\/auth\/mock-numbers": { - "patch": { - "summary": "Update the mock numbers for the project", - "operationId": "projectsUpdateMockNumbers", + ] + }, + "post": { + "summary": "Create project", + "operationId": "projectsCreate", "tags": [ "projects" ], - "description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ", + "description": "Create a new project. You can create a maximum of 100 projects per account. ", "responses": { - "200": { + "201": { "description": "Project", "content": { "application\/json": { @@ -42045,12 +43775,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMockNumbers", - "group": "auth", - "weight": 72, + "method": "create", + "group": "projects", + "weight": 1044, "cookies": false, "type": "", - "demo": "projects\/update-mock-numbers.md", + "demo": "projects\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42060,7 +43790,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } @@ -42070,35 +43800,93 @@ "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": { - "numbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.", - "x-example": null, - "items": { - "type": "object" - } + "projectId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", + "x-example": null + }, + "name": { + "type": "string", + "description": "Project name. Max length: 128 chars.", + "x-example": "" + }, + "teamId": { + "type": "string", + "description": "Team unique ID.", + "x-example": "" + }, + "region": { + "type": "string", + "description": "Project Region.", + "x-example": "fra", + "enum": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "description": { + "type": "string", + "description": "Project description. Max length: 256 chars.", + "x-example": "" + }, + "logo": { + "type": "string", + "description": "Project logo.", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Project URL.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "legalName": { + "type": "string", + "description": "Project legal Name. Max length: 256 chars.", + "x-example": "" + }, + "legalCountry": { + "type": "string", + "description": "Project legal Country. Max length: 256 chars.", + "x-example": "" + }, + "legalState": { + "type": "string", + "description": "Project legal State. Max length: 256 chars.", + "x-example": "" + }, + "legalCity": { + "type": "string", + "description": "Project legal City. Max length: 256 chars.", + "x-example": "" + }, + "legalAddress": { + "type": "string", + "description": "Project legal Address. Max length: 256 chars.", + "x-example": "" + }, + "legalTaxId": { + "type": "string", + "description": "Project legal Tax ID. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "numbers" + "projectId", + "name", + "teamId" ] } } @@ -42106,14 +43894,14 @@ } } }, - "\/projects\/{projectId}\/auth\/password-dictionary": { - "patch": { - "summary": "Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password", - "operationId": "projectsUpdateAuthPasswordDictionary", + "\/projects\/{projectId}": { + "get": { + "summary": "Get project", + "operationId": "projectsGet", "tags": [ "projects" ], - "description": "Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords. ", + "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", "responses": { "200": { "description": "Project", @@ -42128,22 +43916,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthPasswordDictionary", - "group": "auth", - "weight": 69, + "method": "get", + "group": "projects", + "weight": 57, "cookies": false, "type": "", - "demo": "projects\/update-auth-password-dictionary.md", + "demo": "projects\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "projects.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } @@ -42164,36 +43952,15 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to enable checking user's password against most commonly used passwords. Default is false.", - "x-example": false - } - }, - "required": [ - "enabled" - ] - } - } - } - } - } - }, - "\/projects\/{projectId}\/auth\/password-history": { + ] + }, "patch": { - "summary": "Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.", - "operationId": "projectsUpdateAuthPasswordHistory", + "summary": "Update project", + "operationId": "projectsUpdate", "tags": [ "projects" ], - "description": "Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.", + "description": "Update a project by its unique ID.", "responses": { "200": { "description": "Project", @@ -42208,12 +43975,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthPasswordHistory", - "group": "auth", - "weight": 68, + "method": "update", + "group": "projects", + "weight": 1045, "cookies": false, "type": "", - "demo": "projects\/update-auth-password-history.md", + "demo": "projects\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42223,7 +43990,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } @@ -42251,50 +44018,86 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "description": "Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0", - "x-example": 0, - "format": "int32" + "name": { + "type": "string", + "description": "Project name. Max length: 128 chars.", + "x-example": "" + }, + "description": { + "type": "string", + "description": "Project description. Max length: 256 chars.", + "x-example": "" + }, + "logo": { + "type": "string", + "description": "Project logo.", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Project URL.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "legalName": { + "type": "string", + "description": "Project legal name. Max length: 256 chars.", + "x-example": "" + }, + "legalCountry": { + "type": "string", + "description": "Project legal country. Max length: 256 chars.", + "x-example": "" + }, + "legalState": { + "type": "string", + "description": "Project legal state. Max length: 256 chars.", + "x-example": "" + }, + "legalCity": { + "type": "string", + "description": "Project legal city. Max length: 256 chars.", + "x-example": "" + }, + "legalAddress": { + "type": "string", + "description": "Project legal address. Max length: 256 chars.", + "x-example": "" + }, + "legalTaxId": { + "type": "string", + "description": "Project legal tax ID. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "limit" + "name" ] } } } } - } - }, - "\/projects\/{projectId}\/auth\/personal-data": { - "patch": { - "summary": "Update personal data check", - "operationId": "projectsUpdatePersonalDataCheck", + }, + "delete": { + "summary": "Delete project", + "operationId": "projectsDelete", "tags": [ "projects" ], - "description": "Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords. ", + "description": "Delete a project by its unique ID.", "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updatePersonalDataCheck", - "group": "auth", - "weight": 70, + "method": "delete", + "group": "projects", + "weight": 73, "cookies": false, "type": "", - "demo": "projects\/update-personal-data-check.md", + "demo": "projects\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42304,7 +44107,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md", "auth": { "Project": [] } @@ -42325,36 +44128,17 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to check a password for similarity with personal data. Default is false.", - "x-example": false - } - }, - "required": [ - "enabled" - ] - } - } - } - } + ] } }, - "\/projects\/{projectId}\/auth\/session-alerts": { + "\/projects\/{projectId}\/api": { "patch": { - "summary": "Update project sessions emails", - "operationId": "projectsUpdateSessionAlerts", + "summary": "Update API status", + "operationId": "projectsUpdateApiStatus", "tags": [ "projects" ], - "description": "Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.", + "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", "responses": { "200": { "description": "Project", @@ -42367,14 +44151,14 @@ } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateSessionAlerts", - "group": "auth", - "weight": 63, + "method": "updateApiStatus", + "group": "projects", + "weight": 60, "cookies": false, "type": "", - "demo": "projects\/update-session-alerts.md", + "demo": "projects\/update-api-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42383,8 +44167,72 @@ "console" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatus" + }, + "methods": [ + { + "name": "updateApiStatus", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "api", + "status" + ], + "required": [ + "projectId", + "api", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/project" + } + ], + "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", + "demo": "projects\/update-api-status.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatus" + } + }, + { + "name": "updateAPIStatus", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "api", + "status" + ], + "required": [ + "projectId", + "api", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/project" + } + ], + "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", + "demo": "projects\/update-api-status.md", + "public": true + } + ], "auth": { "Project": [] } @@ -42412,14 +44260,27 @@ "schema": { "type": "object", "properties": { - "alerts": { + "api": { + "type": "string", + "description": "API name.", + "x-example": "rest", + "enum": [ + "rest", + "graphql", + "realtime" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "status": { "type": "boolean", - "description": "Set to true to enable session emails.", + "description": "API status.", "x-example": false } }, "required": [ - "alerts" + "api", + "status" ] } } @@ -42427,14 +44288,14 @@ } } }, - "\/projects\/{projectId}\/auth\/session-invalidation": { + "\/projects\/{projectId}\/api\/all": { "patch": { - "summary": "Update invalidate session option of the project", - "operationId": "projectsUpdateSessionInvalidation", + "summary": "Update all API status", + "operationId": "projectsUpdateApiStatusAll", "tags": [ "projects" ], - "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", + "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", "responses": { "200": { "description": "Project", @@ -42447,14 +44308,14 @@ } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateSessionInvalidation", - "group": "auth", - "weight": 93, + "method": "updateApiStatusAll", + "group": "projects", + "weight": 61, "cookies": false, "type": "", - "demo": "projects\/update-session-invalidation.md", + "demo": "projects\/update-api-status-all.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42463,8 +44324,68 @@ "console" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status-all.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatusAll" + }, + "methods": [ + { + "name": "updateApiStatusAll", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "status" + ], + "required": [ + "projectId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/project" + } + ], + "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", + "demo": "projects\/update-api-status-all.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatusAll" + } + }, + { + "name": "updateAPIStatusAll", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "status" + ], + "required": [ + "projectId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/project" + } + ], + "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", + "demo": "projects\/update-api-status-all.md", + "public": true + } + ], "auth": { "Project": [] } @@ -42492,14 +44413,14 @@ "schema": { "type": "object", "properties": { - "enabled": { + "status": { "type": "boolean", - "description": "Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change", + "description": "API status.", "x-example": false } }, "required": [ - "enabled" + "status" ] } } @@ -42507,14 +44428,14 @@ } } }, - "\/projects\/{projectId}\/auth\/{method}": { + "\/projects\/{projectId}\/auth\/duration": { "patch": { - "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", - "operationId": "projectsUpdateAuthStatus", + "summary": "Update project authentication duration", + "operationId": "projectsUpdateAuthDuration", "tags": [ "projects" ], - "description": "Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. ", + "description": "Update how long sessions created within a project should stay active for.", "responses": { "200": { "description": "Project", @@ -42529,12 +44450,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthStatus", + "method": "updateAuthDuration", "group": "auth", - "weight": 67, + "weight": 66, "cookies": false, "type": "", - "demo": "projects\/update-auth-status.md", + "demo": "projects\/update-auth-duration.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -42544,7 +44465,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md", "auth": { "Project": [] } @@ -42564,27 +44485,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "method", - "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", - "required": true, - "schema": { - "type": "string", - "x-example": "email-password", - "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" - ], - "x-enum-name": "AuthMethod", - "x-enum-keys": [] - }, - "in": "path" } ], "requestBody": { @@ -42593,14 +44493,15 @@ "schema": { "type": "object", "properties": { - "status": { - "type": "boolean", - "description": "Set the status of this auth method.", - "x-example": false + "duration": { + "type": "integer", + "description": "Project session length in seconds. Max length: 31536000 seconds.", + "x-example": 0, + "format": "int32" } }, "required": [ - "status" + "duration" ] } } @@ -42608,75 +44509,21 @@ } } }, - "\/projects\/{projectId}\/console-access": { + "\/projects\/{projectId}\/auth\/limit": { "patch": { - "summary": "Record console access to a project", - "operationId": "projectsUpdateConsoleAccess", - "tags": [ - "projects" - ], - "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateConsoleAccess", - "group": null, - "weight": 799, - "cookies": false, - "type": "", - "demo": "projects\/update-console-access.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project ID", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/projects\/{projectId}\/dev-keys": { - "get": { - "summary": "List dev keys", - "operationId": "projectsListDevKeys", + "summary": "Update project users limit", + "operationId": "projectsUpdateAuthLimit", "tags": [ "projects" ], - "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", + "description": "Update the maximum number of users allowed in this project. Set to 0 for unlimited users. ", "responses": { "200": { - "description": "Dev Keys List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKeyList" + "$ref": "#\/components\/schemas\/project" } } } @@ -42684,21 +44531,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listDevKeys", - "group": "devKeys", - "weight": 455, + "method": "updateAuthLimit", + "group": "auth", + "weight": 65, "cookies": false, "type": "", - "demo": "projects\/list-dev-keys.md", + "demo": "projects\/update-auth-limit.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md", "auth": { "Project": [] } @@ -42718,36 +44566,45 @@ "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: accessedAt, expire", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" } - ] - }, - "post": { - "summary": "Create dev key", - "operationId": "projectsCreateDevKey", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Set the max number of users allowed in this project. Use 0 for unlimited.", + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "limit" + ] + } + } + } + } + } + }, + "\/projects\/{projectId}\/auth\/max-sessions": { + "patch": { + "summary": "Update project user sessions limit", + "operationId": "projectsUpdateAuthSessionsLimit", "tags": [ "projects" ], - "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", + "description": "Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.", "responses": { - "201": { - "description": "DevKey", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKey" + "$ref": "#\/components\/schemas\/project" } } } @@ -42755,21 +44612,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDevKey", - "group": "devKeys", - "weight": 452, + "method": "updateAuthSessionsLimit", + "group": "auth", + "weight": 71, "cookies": false, "type": "", - "demo": "projects\/create-dev-key.md", + "demo": "projects\/update-auth-sessions-limit.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md", "auth": { "Project": [] } @@ -42797,20 +44655,15 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Key name. Max length: 128 chars.", - "x-example": "" - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", - "x-example": null + "limit": { + "type": "integer", + "description": "Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10", + "x-example": 1, + "format": "int32" } }, "required": [ - "name", - "expire" + "limit" ] } } @@ -42818,21 +44671,21 @@ } } }, - "\/projects\/{projectId}\/dev-keys\/{keyId}": { - "get": { - "summary": "Get dev key", - "operationId": "projectsGetDevKey", + "\/projects\/{projectId}\/auth\/memberships-privacy": { + "patch": { + "summary": "Update project memberships privacy attributes", + "operationId": "projectsUpdateMembershipsPrivacy", "tags": [ "projects" ], - "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", + "description": "Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status. ", "responses": { "200": { - "description": "DevKey", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKey" + "$ref": "#\/components\/schemas\/project" } } } @@ -42840,21 +44693,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getDevKey", - "group": "devKeys", - "weight": 454, + "method": "updateMembershipsPrivacy", + "group": "auth", + "weight": 64, "cookies": false, "type": "", - "demo": "projects\/get-dev-key.md", + "demo": "projects\/update-memberships-privacy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md", "auth": { "Project": [] } @@ -42874,33 +44728,56 @@ "x-example": "" }, "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } - ] - }, - "put": { - "summary": "Update dev key", - "operationId": "projectsUpdateDevKey", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userName": { + "type": "boolean", + "description": "Set to true to show userName to members of a team.", + "x-example": false + }, + "userEmail": { + "type": "boolean", + "description": "Set to true to show email to members of a team.", + "x-example": false + }, + "mfa": { + "type": "boolean", + "description": "Set to true to show mfa to members of a team.", + "x-example": false + } + }, + "required": [ + "userName", + "userEmail", + "mfa" + ] + } + } + } + } + } + }, + "\/projects\/{projectId}\/auth\/mock-numbers": { + "patch": { + "summary": "Update the mock numbers for the project", + "operationId": "projectsUpdateMockNumbers", "tags": [ "projects" ], - "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", + "description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ", "responses": { "200": { - "description": "DevKey", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKey" + "$ref": "#\/components\/schemas\/project" } } } @@ -42908,21 +44785,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDevKey", - "group": "devKeys", - "weight": 453, + "method": "updateMockNumbers", + "group": "auth", + "weight": 72, "cookies": false, "type": "", - "demo": "projects\/update-dev-key.md", + "demo": "projects\/update-mock-numbers.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", "auth": { "Project": [] } @@ -42942,16 +44820,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -42960,55 +44828,62 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Key name. Max length: 128 chars.", - "x-example": "" - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", - "x-example": null + "numbers": { + "type": "array", + "description": "An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.", + "x-example": null, + "items": { + "type": "object" + } } }, "required": [ - "name", - "expire" + "numbers" ] } } } } - }, - "delete": { - "summary": "Delete dev key", - "operationId": "projectsDeleteDevKey", + } + }, + "\/projects\/{projectId}\/auth\/password-dictionary": { + "patch": { + "summary": "Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password", + "operationId": "projectsUpdateAuthPasswordDictionary", "tags": [ "projects" ], - "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", + "description": "Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords. ", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDevKey", - "group": "devKeys", - "weight": 456, + "method": "updateAuthPasswordDictionary", + "group": "auth", + "weight": 69, "cookies": false, "type": "", - "demo": "projects\/delete-dev-key.md", + "demo": "projects\/update-auth-password-dictionary.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md", "auth": { "Project": [] } @@ -43028,35 +44903,44 @@ "x-example": "" }, "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to enable checking user's password against most commonly used passwords. Default is false.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } } }, - "\/projects\/{projectId}\/jwts": { - "post": { - "summary": "Create JWT", - "operationId": "projectsCreateJWT", + "\/projects\/{projectId}\/auth\/password-history": { + "patch": { + "summary": "Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.", + "operationId": "projectsUpdateAuthPasswordHistory", "tags": [ "projects" ], - "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", + "description": "Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.", "responses": { - "201": { - "description": "JWT", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/jwt" + "$ref": "#\/components\/schemas\/project" } } } @@ -43064,12 +44948,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createJWT", + "method": "updateAuthPasswordHistory", "group": "auth", - "weight": 79, + "weight": 68, "cookies": false, "type": "", - "demo": "projects\/create-jwt.md", + "demo": "projects\/update-auth-password-history.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -43079,7 +44963,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md", "auth": { "Project": [] } @@ -43107,97 +44991,15 @@ "schema": { "type": "object", "properties": { - "scopes": { - "type": "array", - "description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "policies.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - } - }, - "duration": { + "limit": { "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "description": "Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0", "x-example": 0, "format": "int32" } }, "required": [ - "scopes" + "limit" ] } } @@ -43205,21 +45007,21 @@ } } }, - "\/projects\/{projectId}\/keys": { - "get": { - "summary": "List keys", - "operationId": "projectsListKeys", + "\/projects\/{projectId}\/auth\/personal-data": { + "patch": { + "summary": "Update personal data check", + "operationId": "projectsUpdatePersonalDataCheck", "tags": [ "projects" ], - "description": "Get a list of all API keys from the current project. ", + "description": "Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords. ", "responses": { "200": { - "description": "API Keys List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/keyList" + "$ref": "#\/components\/schemas\/project" } } } @@ -43227,22 +45029,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listKeys", - "group": "keys", - "weight": 75, + "method": "updatePersonalDataCheck", + "group": "auth", + "weight": 70, "cookies": false, "type": "", - "demo": "projects\/list-keys.md", + "demo": "projects\/update-personal-data-check.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-keys.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md", "auth": { "Project": [] } @@ -43262,47 +45064,44 @@ "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: expire, accessedAt, name, scopes", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" } - ] - }, - "post": { - "summary": "Create key", - "operationId": "projectsCreateKey", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to check a password for similarity with personal data. Default is false.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/projects\/{projectId}\/auth\/session-alerts": { + "patch": { + "summary": "Update project sessions emails", + "operationId": "projectsUpdateSessionAlerts", "tags": [ "projects" ], - "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "description": "Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.", "responses": { - "201": { - "description": "Key", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/project" } } } @@ -43310,152 +45109,57 @@ }, "deprecated": false, "x-appwrite": { - "method": "createKey", - "group": "keys", - "weight": 74, + "method": "updateSessionAlerts", + "group": "auth", + "weight": 63, "cookies": false, "type": "", - "demo": "projects\/create-key.md", + "demo": "projects\/update-session-alerts.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md", "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": { - "keyId": { - "type": "string", - "description": "Key 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": "Key name. Max length: 128 chars.", - "x-example": "" - }, - "scopes": { - "type": "array", - "description": "Key scopes list. Maximum of 100 scopes are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "policies.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "x-nullable": true - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": null, - "x-nullable": true + } + }, + "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": { + "alerts": { + "type": "boolean", + "description": "Set to true to enable session emails.", + "x-example": false } }, "required": [ - "name", - "scopes" + "alerts" ] } } @@ -43463,21 +45167,21 @@ } } }, - "\/projects\/{projectId}\/keys\/{keyId}": { - "get": { - "summary": "Get key", - "operationId": "projectsGetKey", + "\/projects\/{projectId}\/auth\/session-invalidation": { + "patch": { + "summary": "Update invalidate session option of the project", + "operationId": "projectsUpdateSessionInvalidation", "tags": [ "projects" ], - "description": "Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.", + "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", "responses": { "200": { - "description": "Key", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/project" } } } @@ -43485,22 +45189,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getKey", - "group": "keys", - "weight": 76, + "method": "updateSessionInvalidation", + "group": "auth", + "weight": 83, "cookies": false, "type": "", - "demo": "projects\/get-key.md", + "demo": "projects\/update-session-invalidation.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", "auth": { "Project": [] } @@ -43520,33 +45224,44 @@ "x-example": "" }, "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } - ] - }, - "put": { - "summary": "Update key", - "operationId": "projectsUpdateKey", + ], + "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.", + "operationId": "projectsUpdateAuthStatus", "tags": [ "projects" ], - "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key. ", + "description": "Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. ", "responses": { "200": { - "description": "Key", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/project" } } } @@ -43554,22 +45269,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateKey", - "group": "keys", - "weight": 77, + "method": "updateAuthStatus", + "group": "auth", + "weight": 67, "cookies": false, "type": "", - "demo": "projects\/update-key.md", + "demo": "projects\/update-auth-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", "auth": { "Project": [] } @@ -43591,12 +45306,23 @@ "in": "path" }, { - "name": "keyId", - "description": "Key unique ID.", + "name": "method", + "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "AuthMethod", + "x-enum-keys": [] }, "in": "path" } @@ -43607,117 +45333,29 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Key name. Max length: 128 chars.", - "x-example": "" - }, - "scopes": { - "type": "array", - "description": "Key scopes list. Maximum of 100 events are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "policies.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "x-nullable": true - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": null, - "x-nullable": true + "status": { + "type": "boolean", + "description": "Set the status of this auth method.", + "x-example": false } }, "required": [ - "name", - "scopes" + "status" ] } } } } - }, - "delete": { - "summary": "Delete key", - "operationId": "projectsDeleteKey", + } + }, + "\/projects\/{projectId}\/console-access": { + "patch": { + "summary": "Record console access to a project", + "operationId": "projectsUpdateConsoleAccess", "tags": [ "projects" ], - "description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls. ", + "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", "responses": { "204": { "description": "No content" @@ -43725,22 +45363,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteKey", - "group": "keys", - "weight": 78, + "method": "updateConsoleAccess", + "group": null, + "weight": 1041, "cookies": false, "type": "", - "demo": "projects\/delete-key.md", + "demo": "projects\/update-console-access.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", "auth": { "Project": [] } @@ -43753,42 +45391,32 @@ "parameters": [ { "name": "projectId", - "description": "Project unique ID.", + "description": "Project ID", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ] } }, - "\/projects\/{projectId}\/labels": { - "put": { - "summary": "Update project labels", - "operationId": "projectsUpdateLabels", + "\/projects\/{projectId}\/dev-keys": { + "get": { + "summary": "List dev keys", + "operationId": "projectsListDevKeys", "tags": [ "projects" ], - "description": "Update the project labels by its unique ID. Labels can be used to easily filter projects in an organization.", + "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", "responses": { "200": { - "description": "Project", + "description": "Dev Keys List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/devKeyList" } } } @@ -43796,16 +45424,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLabels", - "group": "projects", - "weight": 460, + "method": "listDevKeys", + "group": "devKeys", + "weight": 451, "cookies": false, "type": "", - "demo": "projects\/update-labels.md", + "demo": "projects\/list-dev-keys.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "devKeys.read", "platforms": [ "console" ], @@ -43830,47 +45458,36 @@ "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: accessedAt, expire", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "labels": { - "type": "array", - "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "x-example": null, - "items": { - "type": "string" - } - } - }, - "required": [ - "labels" - ] - } - } - } - } - } - }, - "\/projects\/{projectId}\/oauth2": { - "patch": { - "summary": "Update project OAuth2", - "operationId": "projectsUpdateOAuth2", + ] + }, + "post": { + "summary": "Create dev key", + "operationId": "projectsCreateDevKey", "tags": [ "projects" ], - "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", + "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/devKey" } } } @@ -43878,22 +45495,21 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateOAuth2", - "group": "auth", - "weight": 62, + "method": "createDevKey", + "group": "devKeys", + "weight": 448, "cookies": false, "type": "", - "demo": "projects\/update-o-auth-2.md", + "demo": "projects\/create-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "devKeys.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", "auth": { "Project": [] } @@ -43921,75 +45537,21 @@ "schema": { "type": "object", "properties": { - "provider": { - "type": "string", - "description": "Provider Name", - "x-example": "amazon", - "enum": [ - "amazon", - "apple", - "auth0", - "authentik", - "autodesk", - "bitbucket", - "bitly", - "box", - "dailymotion", - "discord", - "disqus", - "dropbox", - "etsy", - "facebook", - "figma", - "github", - "gitlab", - "google", - "linkedin", - "microsoft", - "notion", - "oidc", - "okta", - "paypal", - "paypalSandbox", - "podio", - "salesforce", - "slack", - "spotify", - "stripe", - "tradeshift", - "tradeshiftBox", - "twitch", - "wordpress", - "yahoo", - "yammer", - "yandex", - "zoho", - "zoom" - ], - "x-enum-name": "OAuthProvider", - "x-enum-keys": [] - }, - "appId": { + "name": { "type": "string", - "description": "Provider app ID. Max length: 256 chars.", - "x-example": "", - "x-nullable": true + "description": "Key name. Max length: 128 chars.", + "x-example": "" }, - "secret": { + "expire": { "type": "string", - "description": "Provider secret key. Max length: 512 chars.", - "x-example": "", - "x-nullable": true - }, - "enabled": { - "type": "boolean", - "description": "Provider status. Set to 'false' to disable new session creation.", - "x-example": false, - "x-nullable": true + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" } }, "required": [ - "provider" + "name", + "expire" ] } } @@ -43997,21 +45559,21 @@ } } }, - "\/projects\/{projectId}\/platforms": { + "\/projects\/{projectId}\/dev-keys\/{keyId}": { "get": { - "summary": "List platforms", - "operationId": "projectsListPlatforms", + "summary": "Get dev key", + "operationId": "projectsGetDevKey", "tags": [ "projects" ], - "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations. ", + "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", "responses": { "200": { - "description": "Platforms List", + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformList" + "$ref": "#\/components\/schemas\/devKey" } } } @@ -44019,22 +45581,21 @@ }, "deprecated": false, "x-appwrite": { - "method": "listPlatforms", - "group": "platforms", - "weight": 81, + "method": "getDevKey", + "group": "devKeys", + "weight": 450, "cookies": false, "type": "", - "demo": "projects\/list-platforms.md", + "demo": "projects\/get-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "devKeys.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-platforms.md", "auth": { "Project": [] } @@ -44056,32 +45617,31 @@ "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "keyId", + "description": "Key unique ID.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" } ] }, - "post": { - "summary": "Create platform", - "operationId": "projectsCreatePlatform", + "put": { + "summary": "Update dev key", + "operationId": "projectsUpdateDevKey", "tags": [ "projects" ], - "description": "Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", "responses": { - "201": { - "description": "Platform", + "200": { + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platform" + "$ref": "#\/components\/schemas\/devKey" } } } @@ -44089,22 +45649,21 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPlatform", - "group": "platforms", - "weight": 80, + "method": "updateDevKey", + "group": "devKeys", + "weight": 449, "cookies": false, "type": "", - "demo": "projects\/create-platform.md", + "demo": "projects\/update-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "devKeys.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-platform.md", "auth": { "Project": [] } @@ -44124,6 +45683,16 @@ "x-example": "" }, "in": "path" + }, + { + "name": "keyId", + "description": "Key unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -44132,99 +45701,56 @@ "schema": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.", - "x-example": "web", - "enum": [ - "web", - "flutter-web", - "flutter-ios", - "flutter-android", - "flutter-linux", - "flutter-macos", - "flutter-windows", - "apple-ios", - "apple-macos", - "apple-watchos", - "apple-tvos", - "android", - "unity", - "react-native-ios", - "react-native-android" - ], - "x-enum-name": "PlatformType", - "x-enum-keys": [] - }, "name": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "Key name. Max length: 128 chars.", "x-example": "" }, - "key": { - "type": "string", - "description": "Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.", - "x-example": "" - }, - "store": { - "type": "string", - "description": "App store or Google Play store ID. Max length: 256 chars.", - "x-example": "" - }, - "hostname": { + "expire": { "type": "string", - "description": "Platform client hostname. Max length: 256 chars.", - "x-example": null + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" } }, "required": [ - "type", - "name" + "name", + "expire" ] } } } } - } - }, - "\/projects\/{projectId}\/platforms\/{platformId}": { - "get": { - "summary": "Get platform", - "operationId": "projectsGetPlatform", + }, + "delete": { + "summary": "Delete dev key", + "operationId": "projectsDeleteDevKey", "tags": [ "projects" ], - "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations. ", + "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", "responses": { - "200": { - "description": "Platform", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/platform" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getPlatform", - "group": "platforms", - "weight": 82, + "method": "deleteDevKey", + "group": "devKeys", + "weight": 452, "cookies": false, "type": "", - "demo": "projects\/get-platform.md", + "demo": "projects\/delete-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "devKeys.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-platform.md", "auth": { "Project": [] } @@ -44246,31 +45772,33 @@ "in": "path" }, { - "name": "platformId", - "description": "Platform unique ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - }, - "put": { - "summary": "Update platform", - "operationId": "projectsUpdatePlatform", + } + }, + "\/projects\/{projectId}\/jwts": { + "post": { + "summary": "Create JWT", + "operationId": "projectsCreateJWT", "tags": [ "projects" ], - "description": "Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname. ", + "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", "responses": { - "200": { - "description": "Platform", + "201": { + "description": "JWT", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platform" + "$ref": "#\/components\/schemas\/jwt" } } } @@ -44278,22 +45806,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePlatform", - "group": "platforms", - "weight": 83, + "method": "createJWT", + "group": "auth", + "weight": 74, "cookies": false, "type": "", - "demo": "projects\/update-platform.md", + "demo": "projects\/create-jwt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-platform.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", "auth": { "Project": [] } @@ -44313,16 +45841,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "platformId", - "description": "Platform unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -44331,65 +45849,146 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" - }, - "key": { - "type": "string", - "description": "Package name for android or bundle ID for iOS. Max length: 256 chars.", - "x-example": "" - }, - "store": { - "type": "string", - "description": "App store or Google Play store ID. Max length: 256 chars.", - "x-example": "" + "scopes": { + "type": "array", + "description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } }, - "hostname": { - "type": "string", - "description": "Platform client URL. Max length: 256 chars.", - "x-example": null + "duration": { + "type": "integer", + "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "x-example": 0, + "format": "int32" } }, "required": [ - "name" + "scopes" ] } } } } - }, - "delete": { - "summary": "Delete platform", - "operationId": "projectsDeletePlatform", + } + }, + "\/projects\/{projectId}\/oauth2": { + "patch": { + "summary": "Update project OAuth2", + "operationId": "projectsUpdateOAuth2", "tags": [ "projects" ], - "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project. ", + "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deletePlatform", - "group": "platforms", - "weight": 84, + "method": "updateOAuth2", + "group": "auth", + "weight": 62, "cookies": false, "type": "", - "demo": "projects\/delete-platform.md", + "demo": "projects\/update-o-auth-2.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-platform.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", "auth": { "Project": [] } @@ -44409,18 +46008,89 @@ "x-example": "" }, "in": "path" - }, - { - "name": "platformId", - "description": "Platform unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Provider Name", + "x-example": "amazon", + "enum": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "github", + "gitlab", + "google", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ], + "x-enum-name": "OAuthProvider", + "x-enum-keys": [] + }, + "appId": { + "type": "string", + "description": "Provider app ID. Max length: 256 chars.", + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "Provider secret key. Max length: 512 chars.", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Provider status. Set to 'false' to disable new session creation.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "provider" + ] + } + } + } + } } }, "\/projects\/{projectId}\/schedules": { @@ -44447,7 +46117,7 @@ "x-appwrite": { "method": "listSchedules", "group": "schedules", - "weight": 464, + "weight": 459, "cookies": false, "type": "", "demo": "projects\/list-schedules.md", @@ -44530,7 +46200,7 @@ "x-appwrite": { "method": "createSchedule", "group": "schedules", - "weight": 805, + "weight": 1047, "cookies": false, "type": "", "demo": "projects\/create-schedule.md", @@ -44640,7 +46310,7 @@ "x-appwrite": { "method": "getSchedule", "group": "schedules", - "weight": 463, + "weight": 458, "cookies": false, "type": "", "demo": "projects\/get-schedule.md", @@ -44894,7 +46564,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 85, + "weight": 75, "cookies": false, "type": "", "demo": "projects\/update-smtp.md", @@ -45092,7 +46762,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 86, + "weight": 76, "cookies": false, "type": "", "demo": "projects\/create-smtp-test.md", @@ -45300,7 +46970,7 @@ "x-appwrite": { "method": "updateStatus", "group": null, - "weight": 800, + "weight": 1042, "cookies": false, "type": "", "demo": "projects\/update-status.md", @@ -45385,7 +47055,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 801, + "weight": 1043, "cookies": false, "type": "", "demo": "projects\/update-team.md", @@ -45465,7 +47135,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 88, + "weight": 78, "cookies": false, "type": "", "demo": "projects\/get-email-template.md", @@ -45690,7 +47360,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 90, + "weight": 80, "cookies": false, "type": "", "demo": "projects\/update-email-template.md", @@ -45957,7 +47627,7 @@ "x-appwrite": { "method": "deleteEmailTemplate", "group": "templates", - "weight": 92, + "weight": 82, "cookies": false, "type": "", "demo": "projects\/delete-email-template.md", @@ -46184,7 +47854,7 @@ "x-appwrite": { "method": "getSmsTemplate", "group": "templates", - "weight": 87, + "weight": 77, "cookies": false, "type": "", "demo": "projects\/get-sms-template.md", @@ -46470,7 +48140,7 @@ "x-appwrite": { "method": "updateSmsTemplate", "group": "templates", - "weight": 89, + "weight": 79, "cookies": false, "type": "", "demo": "projects\/update-sms-template.md", @@ -46779,7 +48449,7 @@ "x-appwrite": { "method": "deleteSmsTemplate", "group": "templates", - "weight": 91, + "weight": 81, "cookies": false, "type": "", "demo": "projects\/delete-sms-template.md", @@ -47067,7 +48737,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 815, + "weight": 1084, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -47152,7 +48822,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 810, + "weight": 1079, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -47219,7 +48889,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 812, + "weight": 1081, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -47297,7 +48967,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 813, + "weight": 1082, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -47411,7 +49081,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 811, + "weight": 1080, "cookies": false, "type": "", "demo": "proxy\/create-site-rule.md", @@ -47489,7 +49159,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 814, + "weight": 1083, "cookies": false, "type": "", "demo": "proxy\/get-rule.md", @@ -47540,7 +49210,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 816, + "weight": 1085, "cookies": false, "type": "", "demo": "proxy\/delete-rule.md", @@ -47600,7 +49270,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 817, + "weight": 1086, "cookies": false, "type": "", "demo": "proxy\/update-rule-verification.md", @@ -47660,7 +49330,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 522, + "weight": 517, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -47745,7 +49415,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 631, + "weight": 867, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -47901,6 +49571,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -47938,7 +49609,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -48037,7 +49709,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 525, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -48087,7 +49759,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 548, + "weight": 543, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -48137,7 +49809,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 544, + "weight": 539, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -48269,7 +49941,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 545, + "weight": 540, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -48329,7 +50001,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 546, + "weight": 541, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -48401,7 +50073,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 521, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -48461,7 +50133,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 632, + "weight": 868, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -48624,6 +50296,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -48661,7 +50334,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -48749,7 +50423,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 524, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -48811,7 +50485,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 531, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -48892,7 +50566,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 530, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -48987,7 +50661,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 526, + "weight": 521, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -49092,7 +50766,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 534, + "weight": 529, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -49173,7 +50847,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 527, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -49290,7 +50964,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 528, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -49389,7 +51063,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 529, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -49452,7 +51126,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 532, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -49517,7 +51191,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 533, + "weight": 528, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -49608,7 +51282,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 535, + "weight": 530, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -49680,7 +51354,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 537, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -49766,7 +51440,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 536, + "weight": 531, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -49829,7 +51503,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 538, + "weight": 533, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -49901,7 +51575,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 547, + "weight": 542, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -49983,7 +51657,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 541, + "weight": 536, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -50043,7 +51717,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 633, + "weight": 869, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -50135,7 +51809,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 540, + "weight": 535, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -50205,7 +51879,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 542, + "weight": 537, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -50299,7 +51973,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 543, + "weight": 538, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -50371,7 +52045,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 589, + "weight": 584, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -50457,7 +52131,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 587, + "weight": 582, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -50593,7 +52267,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 588, + "weight": 583, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -50654,7 +52328,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 590, + "weight": 585, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -50787,7 +52461,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 591, + "weight": 586, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -50850,7 +52524,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 594, + "weight": 589, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -50949,7 +52623,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 808, + "weight": 1077, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -51051,7 +52725,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 593, + "weight": 588, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -51125,7 +52799,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 595, + "weight": 590, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -51217,7 +52891,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 596, + "weight": 591, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -51286,7 +52960,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 598, + "weight": 593, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -51366,7 +53040,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 597, + "weight": 592, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -51596,7 +53270,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 599, + "weight": 594, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -51683,7 +53357,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 601, + "weight": 596, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -51756,7 +53430,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 602, + "weight": 597, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -51839,7 +53513,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 312, + "weight": 722, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -51925,7 +53599,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 308, + "weight": 718, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -52006,7 +53680,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 379, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -52076,7 +53750,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 375, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -52150,7 +53824,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 376, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -52217,7 +53891,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 377, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -52298,7 +53972,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 378, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -52367,7 +54041,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 380, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -52455,7 +54129,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 314, + "weight": 724, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -52554,7 +54228,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 309, + "weight": 719, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -52615,7 +54289,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 310, + "weight": 720, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -52690,7 +54364,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 311, + "weight": 721, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -52753,7 +54427,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 319, + "weight": 729, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -52852,7 +54526,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 315, + "weight": 725, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -52978,7 +54652,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 316, + "weight": 726, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -53052,7 +54726,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 317, + "weight": 727, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -53108,119 +54782,351 @@ "schema": { "type": "object", "properties": { - "name": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "rowSecurity": { + "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 + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", + "tags": [ + "tablesDB" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTable", + "group": "tables", + "weight": 728, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "tags": [ + "tablesDB" + ], + "description": "List columns in the table.", + "responses": { + "200": { + "description": "Columns List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 734, + "cookies": false, + "type": "", + "demo": "tablesdb\/list-columns.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.read", + "collections.read" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBigint" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 747, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { "type": "string", - "description": "Table name. Max length: 128 chars.", - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "description": "Column Key.", + "x-example": null }, - "rowSecurity": { + "required": { "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Is column required?", "x-example": false }, - "enabled": { + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "description": "Is column an array?", "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } } } - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", - "tags": [ - "tablesDB" - ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 318, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-table.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Columns List", + "description": "ColumnBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnList" + "$ref": "#\/components\/schemas\/columnBigint" } } } @@ -53228,18 +55134,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "listColumns", + "method": "updateBigIntColumn", "group": "columns", - "weight": 324, + "weight": 748, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/update-big-int-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "tables.write", + "collections.write" ], "platforms": [ "console", @@ -53247,7 +55153,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", "auth": { "Project": [] } @@ -53280,30 +55186,62 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "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, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { @@ -53330,7 +55268,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 325, + "weight": 735, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -53442,7 +55380,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 326, + "weight": 736, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -53559,7 +55497,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 327, + "weight": 737, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -53628,7 +55566,8 @@ "default": { "type": "string", "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -53671,7 +55610,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 328, + "weight": 738, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -53744,7 +55683,8 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { @@ -53788,7 +55728,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 329, + "weight": 739, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -53901,7 +55841,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 330, + "weight": 740, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -54019,7 +55959,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 331, + "weight": 741, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -54140,7 +56080,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 332, + "weight": 742, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -54266,7 +56206,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 333, + "weight": 743, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -54393,7 +56333,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 334, + "weight": 744, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -54525,7 +56465,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 335, + "weight": 745, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -54652,7 +56592,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 336, + "weight": 746, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -54784,7 +56724,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 337, + "weight": 749, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -54896,7 +56836,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 338, + "weight": 750, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -55013,7 +56953,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 339, + "weight": 751, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -55127,7 +57067,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 340, + "weight": 752, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -55250,7 +57190,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 357, + "weight": 769, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -55367,7 +57307,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 358, + "weight": 770, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -55484,7 +57424,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 355, + "weight": 767, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -55601,7 +57541,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 356, + "weight": 768, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -55718,7 +57658,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 341, + "weight": 753, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -55832,7 +57772,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 342, + "weight": 754, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -55955,7 +57895,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 343, + "weight": 755, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -56069,7 +58009,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 344, + "weight": 756, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -56192,7 +58132,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 345, + "weight": 757, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -56330,7 +58270,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 347, + "weight": 759, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -56458,7 +58398,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 348, + "weight": 760, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -56586,7 +58526,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 353, + "weight": 765, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -56703,7 +58643,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 354, + "weight": 766, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -56820,7 +58760,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 349, + "weight": 761, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -56933,7 +58873,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 350, + "weight": 762, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -57051,7 +58991,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 351, + "weight": 763, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -57175,7 +59115,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 352, + "weight": 764, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -57330,7 +59270,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 322, + "weight": 732, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -57406,7 +59346,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 323, + "weight": 733, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -57491,7 +59431,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 346, + "weight": 758, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -57606,7 +59546,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 362, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -57704,7 +59644,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 359, + "weight": 771, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -57844,7 +59784,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 360, + "weight": 772, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -57920,7 +59860,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 361, + "weight": 773, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -58005,7 +59945,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 320, + "weight": 730, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -58092,7 +60032,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 371, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -58180,7 +60120,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "schema": { "type": "integer", @@ -58215,7 +60155,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 363, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -58397,7 +60337,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 368, + "weight": 780, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -58529,7 +60469,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 366, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -58633,7 +60573,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 370, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -58734,7 +60674,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 364, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -58844,7 +60784,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 367, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -58994,7 +60934,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 365, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -59105,7 +61045,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 369, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -59211,7 +61151,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 372, + "weight": 784, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -59308,7 +61248,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 374, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -59436,7 +61376,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 373, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -59564,7 +61504,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 321, + "weight": 731, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -59660,7 +61600,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 313, + "weight": 723, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -59772,7 +61712,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 570, + "weight": 565, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -59861,7 +61801,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 568, + "weight": 563, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -59948,7 +61888,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 569, + "weight": 564, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -60012,7 +61952,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 572, + "weight": 567, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -60088,7 +62028,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 571, + "weight": 566, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -60154,7 +62094,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 581, + "weight": 576, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -60239,7 +62179,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 577, + "weight": 572, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -60338,7 +62278,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 575, + "weight": 570, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -60454,7 +62394,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 576, + "weight": 571, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -60528,7 +62468,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 578, + "weight": 573, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -60617,7 +62557,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 809, + "weight": 1078, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -60693,7 +62633,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 580, + "weight": 575, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -60792,7 +62732,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 573, + "weight": 568, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -60854,7 +62794,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 574, + "weight": 569, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -60937,7 +62877,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 584, + "weight": 579, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -61031,7 +62971,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 582, + "weight": 577, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -61086,7 +63026,8 @@ "expire": { "type": "string", "description": "Token expiry date", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -61120,7 +63061,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 583, + "weight": 578, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -61180,7 +63121,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 585, + "weight": 580, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -61225,7 +63166,8 @@ "expire": { "type": "string", "description": "File token expiry date", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -61250,7 +63192,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 586, + "weight": 581, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -61312,7 +63254,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 104, + "weight": 94, "cookies": false, "type": "", "demo": "users\/list.md", @@ -61398,7 +63340,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 95, + "weight": 85, "cookies": false, "type": "", "demo": "users\/create.md", @@ -61492,7 +63434,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 98, + "weight": 88, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -61581,7 +63523,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 96, + "weight": 86, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -61670,7 +63612,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 112, + "weight": 102, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -61751,7 +63693,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 136, + "weight": 126, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -61814,7 +63756,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 97, + "weight": 87, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -61903,7 +63845,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 100, + "weight": 90, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -61992,7 +63934,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 101, + "weight": 91, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -62115,7 +64057,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 102, + "weight": 92, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -62222,7 +64164,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 99, + "weight": 89, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -62331,7 +64273,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 138, + "weight": 128, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -62404,7 +64346,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 105, + "weight": 95, "cookies": false, "type": "", "demo": "users\/get.md", @@ -62458,7 +64400,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 134, + "weight": 124, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -62521,7 +64463,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 119, + "weight": 109, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -62604,7 +64546,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 115, + "weight": 105, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -62686,7 +64628,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 137, + "weight": 127, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -62771,7 +64713,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 114, + "weight": 104, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -62856,7 +64798,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 110, + "weight": 100, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -62943,7 +64885,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 109, + "weight": 99, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -63041,7 +64983,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 124, + "weight": 114, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -63176,7 +65118,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 129, + "weight": 119, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -63312,7 +65254,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 125, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -63431,7 +65373,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 126, + "weight": 116, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -63548,7 +65490,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 128, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -63665,7 +65607,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 127, + "weight": 117, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -63784,7 +65726,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 117, + "weight": 107, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -63866,7 +65808,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 118, + "weight": 108, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -63948,7 +65890,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 120, + "weight": 110, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -64031,7 +65973,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 106, + "weight": 96, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -64092,7 +66034,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 122, + "weight": 112, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -64174,7 +66116,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 108, + "weight": 98, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -64246,7 +66188,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 130, + "weight": 120, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -64300,7 +66242,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 133, + "weight": 123, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -64356,7 +66298,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 132, + "weight": 122, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -64429,7 +66371,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 113, + "weight": 103, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -64511,7 +66453,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 111, + "weight": 101, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -64596,7 +66538,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 103, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -64707,7 +66649,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 107, + "weight": 97, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -64778,7 +66720,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 123, + "weight": 113, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -64868,7 +66810,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 135, + "weight": 125, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -64941,7 +66883,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 131, + "weight": 121, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -65027,7 +66969,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 121, + "weight": 111, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -65109,7 +67051,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 116, + "weight": 106, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -65177,11 +67119,18 @@ "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", "responses": { "200": { - "description": "DetectionFramework", + "description": "DetectionRuntime, or DetectionFramework", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/detectionFramework" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/detectionRuntime" + }, + { + "$ref": "#\/components\/schemas\/detectionFramework" + } + ] } } } @@ -65191,7 +67140,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 614, + "weight": 609, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -65274,11 +67223,18 @@ "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", "responses": { "200": { - "description": "Framework Provider Repositories List", + "description": "Runtime Provider Repositories List, or Framework Provider Repositories List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/providerRepositoryFrameworkList" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/providerRepositoryRuntimeList" + }, + { + "$ref": "#\/components\/schemas\/providerRepositoryFrameworkList" + } + ] } } } @@ -65288,7 +67244,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 611, + "weight": 606, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -65387,7 +67343,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 609, + "weight": 604, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -65473,7 +67429,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 610, + "weight": 605, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -65544,7 +67500,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 612, + "weight": 607, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -65615,7 +67571,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 613, + "weight": 608, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -65701,7 +67657,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 819, + "weight": 1088, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -65791,7 +67747,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 607, + "weight": 602, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -65877,7 +67833,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 606, + "weight": 601, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -65929,7 +67885,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 608, + "weight": 603, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -65990,7 +67946,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 421, + "weight": 833, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -66076,7 +68032,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 417, + "weight": 829, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -66157,7 +68113,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 445, + "weight": 857, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -66268,7 +68224,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 450, + "weight": 862, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -66335,7 +68291,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 446, + "weight": 858, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -66406,7 +68362,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 447, + "weight": 859, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -66470,7 +68426,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 448, + "weight": 860, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -66548,7 +68504,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 449, + "weight": 861, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -66614,7 +68570,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 451, + "weight": 863, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -66699,7 +68655,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 423, + "weight": 835, "cookies": false, "type": "", "demo": "vectorsdb\/list-usage.md", @@ -66795,7 +68751,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 418, + "weight": 830, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -66856,7 +68812,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 419, + "weight": 831, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -66934,7 +68890,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 420, + "weight": 832, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -66997,7 +68953,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 428, + "weight": 840, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -67093,7 +69049,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 424, + "weight": 836, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -67206,7 +69162,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 425, + "weight": 837, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -67277,7 +69233,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 426, + "weight": 838, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -67384,7 +69340,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 427, + "weight": 839, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -67457,7 +69413,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 439, + "weight": 851, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -67577,7 +69533,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 435, + "weight": 847, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -67752,7 +69708,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 442, + "weight": 854, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -67880,7 +69836,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 441, + "weight": 853, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -67980,7 +69936,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 443, + "weight": 855, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -68077,7 +70033,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 438, + "weight": 850, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -68184,7 +70140,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 437, + "weight": 849, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -68329,7 +70285,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 436, + "weight": 848, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -68435,7 +70391,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 440, + "weight": 852, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -68537,7 +70493,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 444, + "weight": 856, "cookies": false, "type": "", "demo": "vectorsdb\/list-document-logs.md", @@ -68631,7 +70587,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 434, + "weight": 846, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -68726,7 +70682,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 431, + "weight": 843, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -68865,7 +70821,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 432, + "weight": 844, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -68938,7 +70894,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 433, + "weight": 845, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -69020,7 +70976,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 429, + "weight": 841, "cookies": false, "type": "", "demo": "vectorsdb\/list-collection-logs.md", @@ -69104,7 +71060,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 430, + "weight": 842, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection-usage.md", @@ -69197,7 +71153,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 422, + "weight": 834, "cookies": false, "type": "", "demo": "vectorsdb\/get-usage.md", @@ -69306,7 +71262,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 617, + "weight": 612, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -69380,7 +71336,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 616, + "weight": 611, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -69490,7 +71446,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 618, + "weight": 613, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -69550,7 +71506,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 620, + "weight": 615, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -69657,7 +71613,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 619, + "weight": 614, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -69719,7 +71675,7 @@ "x-appwrite": { "method": "updateSignature", "group": null, - "weight": 621, + "weight": 616, "cookies": false, "type": "", "demo": "webhooks\/update-signature.md", @@ -70774,34 +72730,6 @@ "devKeys": "" } }, - "platformList": { - "description": "Platforms List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of platforms that matched your query.", - "x-example": 5, - "format": "int32" - }, - "platforms": { - "type": "array", - "description": "List of platforms.", - "items": { - "$ref": "#\/components\/schemas\/platform" - }, - "x-example": "" - } - }, - "required": [ - "total", - "platforms" - ], - "example": { - "total": 5, - "platforms": "" - } - }, "countryList": { "description": "Countries List", "type": "object", @@ -71576,6 +73504,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -71698,6 +73629,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -71954,6 +73888,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for 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" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -74044,6 +76076,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -74166,6 +76201,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -74422,6 +76460,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int32", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -76197,6 +78333,11 @@ "description": "API mode when event triggered.", "x-example": "admin" }, + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" + }, "ip": { "type": "string", "description": "IP session in use when the session was created.", @@ -76284,6 +78425,7 @@ "userEmail", "userName", "mode", + "userType", "ip", "time", "osCode", @@ -76307,6 +78449,7 @@ "userEmail": "john@appwrite.io", "userName": "John Doe", "mode": "admin", + "userType": "user", "ip": "127.0.0.1", "time": "2020-10-15T06:38:00.000+00:00", "osCode": "Mac", @@ -79731,6 +81874,21 @@ "description": "Whether or not to check the user password for similarity with their personal data.", "x-example": true }, + "authDisposableEmails": { + "type": "boolean", + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true + }, + "authCanonicalEmails": { + "type": "boolean", + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true + }, + "authFreeEmails": { + "type": "boolean", + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true + }, "authMockNumbers": { "type": "array", "description": "An array of mock numbers and their corresponding verification codes (OTPs).", @@ -79780,7 +81938,23 @@ "type": "array", "description": "List of Platforms.", "items": { - "$ref": "#\/components\/schemas\/platform" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ] }, "x-example": {} }, @@ -80028,6 +82202,9 @@ "authPasswordHistory", "authPasswordDictionary", "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", "authMockNumbers", "authSessionAlerts", "authMembershipsUserName", @@ -80098,6 +82275,9 @@ "authPasswordHistory": 5, "authPasswordDictionary": true, "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, "authMockNumbers": [ {} ], @@ -80482,8 +82662,186 @@ "enabled": "" } }, - "platform": { - "description": "Platform", + "platformWeb": { + "description": "Platform Web", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "hostname": { + "type": "string", + "description": "Web app hostname. Empty string for other platforms.", + "x-example": "app.example.com" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "hostname", + "key" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "hostname": "app.example.com" + } + }, + "platformApple": { + "description": "Platform Apple", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "bundleIdentifier" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "bundleIdentifier": "com.company.appname" + } + }, + "platformAndroid": { + "description": "Platform Android", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "applicationId": { + "type": "string", + "description": "Android application ID.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "applicationId" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "applicationId": "com.company.appname" + } + }, + "platformWindows": { + "description": "Platform Windows", "type": "object", "properties": { "$id": { @@ -80508,50 +82866,79 @@ }, "type": { "type": "string", - "description": "Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", "x-example": "web", "enum": [ - "web", - "flutter-web", - "flutter-ios", - "flutter-android", - "flutter-linux", - "flutter-macos", - "flutter-windows", - "apple-ios", - "apple-macos", - "apple-watchos", - "apple-tvos", + "windows", + "apple", "android", - "unity", - "react-native-ios", - "react-native-android" + "linux", + "web" ] }, - "key": { + "packageIdentifierName": { "type": "string", - "description": "Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.", + "description": "Windows package identifier name.", "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "packageIdentifierName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "packageIdentifierName": "com.company.appname" + } + }, + "platformLinux": { + "description": "Platform Linux", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" }, - "store": { + "$createdAt": { "type": "string", - "description": "App store or Google Play store ID.", - "x-example": "" + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "hostname": { + "$updatedAt": { "type": "string", - "description": "Web app hostname. Empty string for other platforms.", - "x-example": "app.example.com" + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "httpUser": { + "name": { "type": "string", - "description": "HTTP basic authentication username.", - "x-example": "username" + "description": "Platform name.", + "x-example": "My Web App" }, - "httpPass": { + "type": { "type": "string", - "description": "HTTP basic authentication password.", - "x-example": "password" + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "packageName": { + "type": "string", + "description": "Linux package name.", + "x-example": "com.company.appname" } }, "required": [ @@ -80560,11 +82947,7 @@ "$updatedAt", "name", "type", - "key", - "store", - "hostname", - "httpUser", - "httpPass" + "packageName" ], "example": { "$id": "5e5ea5c16897e", @@ -80572,11 +82955,51 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Web App", "type": "web", - "key": "com.company.appname", - "store": "", - "hostname": "app.example.com", - "httpUser": "username", - "httpPass": "password" + "packageName": "com.company.appname" + } + }, + "platformList": { + "description": "Platforms List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of platforms in the given project.", + "x-example": 5, + "format": "int32" + }, + "platforms": { + "type": "array", + "description": "List of platforms.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "platforms" + ], + "example": { + "total": 5, + "platforms": "" } }, "variable": { @@ -83838,6 +86261,11 @@ "type": "boolean", "description": "Whether the database adapter uses integer sequence IDs.", "x-example": true + }, + "_APP_CONSOLE_EMAIL_VERIFICATION": { + "type": "string", + "description": "Whether email verification for console users is required. Can be \"true\" or \"false\".", + "x-example": "true" } }, "required": [ @@ -83866,7 +86294,8 @@ "supportForAttributeResizing", "supportForSchemas", "maxIndexLength", - "supportForIntegerIds" + "supportForIntegerIds", + "_APP_CONSOLE_EMAIL_VERIFICATION" ], "example": { "_APP_DOMAIN_TARGET_CNAME": "appwrite.io", @@ -83894,7 +86323,8 @@ "supportForAttributeResizing": true, "supportForSchemas": true, "maxIndexLength": 768, - "supportForIntegerIds": true + "supportForIntegerIds": true, + "_APP_CONSOLE_EMAIL_VERIFICATION": "true" } }, "mfaChallenge": { @@ -85814,6 +88244,21 @@ "description": "Does plan support credit", "x-example": true }, + "supportsDisposableEmailValidation": { + "type": "boolean", + "description": "Does plan support blocking disposable email addresses.", + "x-example": true + }, + "supportsCanonicalEmailValidation": { + "type": "boolean", + "description": "Does plan support requiring canonical email addresses.", + "x-example": true + }, + "supportsFreeEmailValidation": { + "type": "boolean", + "description": "Does plan support blocking free email addresses.", + "x-example": true + }, "backupsEnabled": { "type": "boolean", "description": "Does plan support backup policies.", @@ -85824,6 +88269,14 @@ "description": "Whether usage addons are calculated per project.", "x-example": true }, + "supportedAddons": { + "type": "object", + "description": "Supported addons for this plan", + "x-example": null, + "items": { + "$ref": "#\/components\/schemas\/billingPlanSupportedAddons" + } + }, "backupPolicies": { "type": "integer", "description": "How many policies does plan support", @@ -85927,8 +88380,12 @@ "supportsMockNumbers", "supportsOrganizationRoles", "supportsCredits", + "supportsDisposableEmailValidation", + "supportsCanonicalEmailValidation", + "supportsFreeEmailValidation", "backupsEnabled", "usagePerProject", + "supportedAddons", "backupPolicies", "deploymentSize", "buildSize", @@ -85986,8 +88443,12 @@ "supportsMockNumbers": true, "supportsOrganizationRoles": true, "supportsCredits": true, + "supportsDisposableEmailValidation": true, + "supportsCanonicalEmailValidation": true, + "supportsFreeEmailValidation": true, "backupsEnabled": true, "usagePerProject": true, + "supportedAddons": null, "backupPolicies": true, "deploymentSize": 30, "buildSize": 2000, @@ -86121,6 +88582,23 @@ "dailyCredits": 5 } }, + "billingPlanSupportedAddons": { + "description": "BillingPlanSupportedAddons", + "type": "object", + "properties": { + "baa": { + "type": "boolean", + "description": "Whether the plan supports BAA (Business Associate Agreement) addon", + "x-example": true + } + }, + "required": [ + "baa" + ], + "example": { + "baa": true + } + }, "billingLimits": { "description": "BillingLimits", "type": "object", @@ -86216,21 +88694,21 @@ }, "reason": { "type": "string", - "description": "Reason for the block", - "x-example": "Payment overdue" + "description": "Reason for the block. Can be null if no reason was provided.", + "x-example": "Payment overdue", + "nullable": true }, "expiredAt": { "type": "string", - "description": "Block expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true } }, "required": [ "$createdAt", "resourceType", - "resourceId", - "reason", - "expiredAt" + "resourceId" ], "example": { "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -87198,19 +89676,26 @@ "type": "string", "description": "Invoice ID against which the payment needs to be validated.", "x-example": "" + }, + "addonId": { + "type": "string", + "description": "Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.", + "x-example": "" } }, "required": [ "message", "clientSecret", "organizationId", - "invoiceId" + "invoiceId", + "addonId" ], "example": { "message": "", "clientSecret": "", "organizationId": "", - "invoiceId": "" + "invoiceId": "", + "addonId": "" } }, "paymentMethod": { @@ -88935,6 +91420,165 @@ "available": true } }, + "addon": { + "description": "Addon", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Addon ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Addon creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Addon update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Addon permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "key": { + "type": "string", + "description": "Addon key", + "x-example": "baa" + }, + "resourceType": { + "type": "string", + "description": "Resource type (organization or project)", + "x-example": "organization" + }, + "resourceId": { + "type": "string", + "description": "Resource ID", + "x-example": "5e5ea5c16897e" + }, + "status": { + "type": "string", + "description": "Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).", + "x-example": "active" + }, + "currentValue": { + "type": "integer", + "description": "Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.", + "x-example": 1, + "format": "int32" + }, + "nextValue": { + "type": "integer", + "description": "Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.", + "x-example": null, + "format": "int32", + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "key", + "resourceType", + "resourceId", + "status", + "currentValue" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "key": "baa", + "resourceType": "organization", + "resourceId": "5e5ea5c16897e", + "status": "active", + "currentValue": 1, + "nextValue": null + } + }, + "addonPrice": { + "description": "AddonPrice", + "type": "object", + "properties": { + "addonKey": { + "type": "string", + "description": "Addon key.", + "x-example": "baa" + }, + "name": { + "type": "string", + "description": "Addon display name.", + "x-example": "HIPAA BAA" + }, + "monthlyPrice": { + "type": "number", + "description": "Full monthly price of the addon.", + "x-example": 350, + "format": "double" + }, + "proratedAmount": { + "type": "number", + "description": "Calculated prorated amount for the current billing cycle.", + "x-example": 175.5, + "format": "double" + }, + "remainingDays": { + "type": "integer", + "description": "Days remaining in the current billing cycle.", + "x-example": 15, + "format": "int32" + }, + "totalCycleDays": { + "type": "integer", + "description": "Total days in the billing cycle.", + "x-example": 30, + "format": "int32" + }, + "currency": { + "type": "string", + "description": "Currency code.", + "x-example": "USD" + }, + "billingCycleEnd": { + "type": "string", + "description": "When the current billing cycle ends.", + "x-example": "2024-02-01T00:00:00.000+00:00" + } + }, + "required": [ + "addonKey", + "name", + "monthlyPrice", + "proratedAmount", + "remainingDays", + "totalCycleDays", + "currency", + "billingCycleEnd" + ], + "example": { + "addonKey": "baa", + "name": "HIPAA BAA", + "monthlyPrice": 350, + "proratedAmount": 175.5, + "remainingDays": 15, + "totalCycleDays": 30, + "currency": "USD", + "billingCycleEnd": "2024-02-01T00:00:00.000+00:00" + } + }, "domainTransferOut": { "description": "domainTransferOut", "type": "object", @@ -88994,6 +91638,34 @@ "timestamp": "2020-10-15T06:38:00.000+00:00" } }, + "addonList": { + "description": "Addons list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of addons that matched your query.", + "x-example": 5, + "format": "int32" + }, + "addons": { + "type": "array", + "description": "List of addons.", + "items": { + "$ref": "#\/components\/schemas\/addon" + }, + "x-example": "" + } + }, + "required": [ + "total", + "addons" + ], + "example": { + "total": 5, + "addons": "" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", @@ -89410,7 +92082,10 @@ "type": "apiKey", "name": "X-Appwrite-JWT", "description": "Your secret JSON Web Token", - "in": "header" + "in": "header", + "x-appwrite": { + "demo": "" + } }, "Locale": { "type": "apiKey", diff --git a/specs/latest/open-api3-latest-server.json b/specs/latest/open-api3-latest-server.json index 6ec1ffbc..911b7e6d 100644 --- a/specs/latest/open-api3-latest-server.json +++ b/specs/latest/open-api3-latest-server.json @@ -562,7 +562,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 213, + "weight": 205, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -635,7 +635,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 215, + "weight": 207, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -762,7 +762,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 216, + "weight": 208, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -905,7 +905,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 217, + "weight": 209, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1032,7 +1032,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 221, + "weight": 213, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1169,7 +1169,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 222, + "weight": 214, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1310,7 +1310,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 214, + "weight": 206, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1414,7 +1414,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 220, + "weight": 212, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1516,7 +1516,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 218, + "weight": 210, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1618,7 +1618,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 219, + "weight": 211, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3173,7 +3173,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -3213,6 +3213,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -3768,7 +3769,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 806, + "weight": 1075, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -3832,7 +3833,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 807, + "weight": 1076, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -3889,7 +3890,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 224, + "weight": 216, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4019,7 +4020,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 223, + "weight": 215, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4155,7 +4156,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 227, + "weight": 219, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4217,7 +4218,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 225, + "weight": 217, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4709,7 +4710,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 226, + "weight": 218, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4795,7 +4796,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 229, + "weight": 221, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -4891,7 +4892,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 228, + "weight": 220, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -4987,7 +4988,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 230, + "weight": 222, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5742,7 +5743,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 774, + "weight": 1016, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5807,7 +5808,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 775, + "weight": 1017, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -5897,7 +5898,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 773, + "weight": 1015, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -5952,7 +5953,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 776, + "weight": 1018, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6016,7 +6017,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 769, + "weight": 1011, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6081,7 +6082,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 770, + "weight": 1012, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6200,7 +6201,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 768, + "weight": 1010, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6262,7 +6263,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 771, + "weight": 1013, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6352,7 +6353,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 772, + "weight": 1014, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6416,7 +6417,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 779, + "weight": 1021, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6516,7 +6517,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 778, + "weight": 1020, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6583,7 +6584,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 777, + "weight": 1019, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6647,7 +6648,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 238, + "weight": 646, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6768,7 +6769,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 234, + "weight": 642, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -6887,7 +6888,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 306, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6956,7 +6957,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 302, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7029,7 +7030,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 303, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7095,7 +7096,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 304, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7175,7 +7176,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 305, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7243,7 +7244,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 307, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7330,7 +7331,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 235, + "weight": 643, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7426,7 +7427,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 236, + "weight": 644, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7538,7 +7539,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 237, + "weight": 645, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7635,7 +7636,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 246, + "weight": 654, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7736,7 +7737,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 242, + "weight": 650, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -7864,7 +7865,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 243, + "weight": 651, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -7940,7 +7941,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 244, + "weight": 652, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8021,6 +8022,11 @@ "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false } } } @@ -8044,7 +8050,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 245, + "weight": 653, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8122,7 +8128,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 263, + "weight": 671, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8200,21 +8206,21 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -8222,12 +8228,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 264, + "weight": 684, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8238,10 +8244,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [], @@ -8267,7 +8273,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", @@ -8292,10 +8298,25 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -8314,21 +8335,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/attributeBigint" } } } @@ -8336,12 +8357,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "updateBigIntAttribute", "group": "attributes", - "weight": 265, + "weight": 685, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/update-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8352,10 +8373,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.updateBigIntColumn" }, "auth": { "Project": [], @@ -8381,7 +8402,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -8410,15 +8431,30 @@ "description": "Is attribute required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } @@ -8433,21 +8469,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { "post": { - "summary": "Create datetime attribute", - "operationId": "databasesCreateDatetimeAttribute", + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", "tags": [ "databases" ], - "description": "Create a date time attribute according to the ISO 8601 standard.", + "description": "Create a boolean attribute.\n", "responses": { "202": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/attributeBoolean" } } } @@ -8455,12 +8491,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDatetimeAttribute", + "method": "createBooleanAttribute", "group": "attributes", - "weight": 266, + "weight": 672, "cookies": false, "type": "", - "demo": "databases\/create-datetime-attribute.md", + "demo": "databases\/create-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8471,10 +8507,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createDatetimeColumn" + "replaceWith": "tablesDB.createBooleanColumn" }, "auth": { "Project": [], @@ -8500,7 +8536,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "schema": { "type": "string", @@ -8526,9 +8562,9 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", - "x-example": null, + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, "x-nullable": true }, "array": { @@ -8547,21 +8583,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { "patch": { - "summary": "Update datetime attribute", - "operationId": "databasesUpdateDatetimeAttribute", + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", "tags": [ "databases" ], - "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/attributeBoolean" } } } @@ -8569,12 +8605,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDatetimeAttribute", + "method": "updateBooleanAttribute", "group": "attributes", - "weight": 267, + "weight": 673, "cookies": false, "type": "", - "demo": "databases\/update-datetime-attribute.md", + "demo": "databases\/update-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8585,10 +8621,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateDatetimeColumn" + "replaceWith": "tablesDB.updateBooleanColumn" }, "auth": { "Project": [], @@ -8614,7 +8650,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -8644,9 +8680,9 @@ "x-example": false }, "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": null, + "x-example": false, "x-nullable": true }, "newKey": { @@ -8666,21 +8702,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { "post": { - "summary": "Create email attribute", - "operationId": "databasesCreateEmailAttribute", + "summary": "Create datetime attribute", + "operationId": "databasesCreateDatetimeAttribute", "tags": [ "databases" ], - "description": "Create an email attribute.\n", + "description": "Create a date time attribute according to the ISO 8601 standard.", "responses": { "202": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/attributeDatetime" } } } @@ -8688,12 +8724,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createEmailAttribute", + "method": "createDatetimeAttribute", "group": "attributes", - "weight": 268, + "weight": 674, "cookies": false, "type": "", - "demo": "databases\/create-email-attribute.md", + "demo": "databases\/create-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8704,10 +8740,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEmailColumn" + "replaceWith": "tablesDB.createDatetimeColumn" }, "auth": { "Project": [], @@ -8733,7 +8769,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -8760,9 +8796,9 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", - "format": "email", + "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -8781,21 +8817,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update email attribute", - "operationId": "databasesUpdateEmailAttribute", + "summary": "Update datetime attribute", + "operationId": "databasesUpdateDatetimeAttribute", "tags": [ "databases" ], - "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/attributeDatetime" } } } @@ -8803,12 +8839,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateEmailAttribute", + "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 269, + "weight": 675, "cookies": false, "type": "", - "demo": "databases\/update-email-attribute.md", + "demo": "databases\/update-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8819,10 +8855,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateEmailColumn" + "replaceWith": "tablesDB.updateDatetimeColumn" }, "auth": { "Project": [], @@ -8880,13 +8916,13 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", - "format": "email", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "x-example": null, "x-nullable": true } @@ -8901,21 +8937,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { "post": { - "summary": "Create enum attribute", - "operationId": "databasesCreateEnumAttribute", + "summary": "Create email attribute", + "operationId": "databasesCreateEmailAttribute", "tags": [ "databases" ], - "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an email attribute.\n", "responses": { "202": { - "description": "AttributeEnum", + "description": "AttributeEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEnum" + "$ref": "#\/components\/schemas\/attributeEmail" } } } @@ -8923,12 +8959,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createEnumAttribute", + "method": "createEmailAttribute", "group": "attributes", - "weight": 270, + "weight": 676, "cookies": false, "type": "", - "demo": "databases\/create-enum-attribute.md", + "demo": "databases\/create-email-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8939,10 +8975,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEnumColumn" + "replaceWith": "tablesDB.createEmailColumn" }, "auth": { "Project": [], @@ -8988,14 +9024,6 @@ "description": "Attribute Key.", "x-example": null }, - "elements": { - "type": "array", - "description": "Array of enum values.", - "x-example": null, - "items": { - "type": "string" - } - }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -9004,7 +9032,8 @@ "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "array": { @@ -9015,7 +9044,6 @@ }, "required": [ "key", - "elements", "required" ] } @@ -9024,21 +9052,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { "patch": { - "summary": "Update enum attribute", - "operationId": "databasesUpdateEnumAttribute", + "summary": "Update email attribute", + "operationId": "databasesUpdateEmailAttribute", "tags": [ "databases" ], - "description": "Update an enum attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeEnum", + "description": "AttributeEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeEnum" + "$ref": "#\/components\/schemas\/attributeEmail" } } } @@ -9046,12 +9074,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateEnumAttribute", + "method": "updateEmailAttribute", "group": "attributes", - "weight": 271, + "weight": 677, "cookies": false, "type": "", - "demo": "databases\/update-enum-attribute.md", + "demo": "databases\/update-email-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9062,10 +9090,253 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateEnumColumn" + "replaceWith": "tablesDB.updateEmailColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "post": { + "summary": "Create enum attribute", + "operationId": "databasesCreateEnumAttribute", + "tags": [ + "databases" + ], + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "responses": { + "202": { + "description": "AttributeEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeEnum" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "createEnumAttribute", + "group": "attributes", + "weight": 678, + "cookies": false, + "type": "", + "demo": "databases\/create-enum-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createEnumColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}": { + "patch": { + "summary": "Update enum attribute", + "operationId": "databasesUpdateEnumAttribute", + "tags": [ + "databases" + ], + "description": "Update an enum attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeEnum", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeEnum" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateEnumAttribute", + "group": "attributes", + "weight": 679, + "cookies": false, + "type": "", + "demo": "databases\/update-enum-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateEnumColumn" }, "auth": { "Project": [], @@ -9176,7 +9447,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 272, + "weight": 680, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9305,7 +9576,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 273, + "weight": 681, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9439,7 +9710,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 274, + "weight": 682, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9568,7 +9839,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 275, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9702,7 +9973,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 276, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9816,7 +10087,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 277, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -9935,7 +10206,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 278, + "weight": 688, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10051,7 +10322,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 279, + "weight": 689, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10176,7 +10447,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 296, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10291,7 +10562,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 297, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10406,7 +10677,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 294, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10521,7 +10792,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 295, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10636,7 +10907,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 280, + "weight": 690, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10752,7 +11023,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 281, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10877,7 +11148,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 282, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -10993,7 +11264,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 283, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11118,7 +11389,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11258,7 +11529,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -11374,7 +11645,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 696, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -11500,7 +11771,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 697, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -11626,7 +11897,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 292, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -11741,7 +12012,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 293, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -11856,7 +12127,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -11971,7 +12242,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -12091,7 +12362,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 290, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -12213,7 +12484,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 291, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -12366,7 +12637,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 261, + "weight": 669, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -12444,7 +12715,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 262, + "weight": 670, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -12531,7 +12802,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 257, + "weight": 665, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12622,7 +12893,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "schema": { "type": "integer", @@ -12657,7 +12928,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 249, + "weight": 657, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12852,7 +13123,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 254, + "weight": 662, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -12991,7 +13262,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 252, + "weight": 660, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13097,7 +13368,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 256, + "weight": 664, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13200,7 +13471,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 250, + "weight": 658, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13313,7 +13584,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 253, + "weight": 661, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13471,7 +13742,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 251, + "weight": 659, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13585,7 +13856,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 255, + "weight": 663, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13694,7 +13965,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 260, + "weight": 668, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13825,7 +14096,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 259, + "weight": 667, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -13956,7 +14227,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 301, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14056,7 +14327,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 298, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14198,7 +14469,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 299, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14276,7 +14547,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 300, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14363,7 +14634,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 385, + "weight": 797, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -14450,7 +14721,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 381, + "weight": 793, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -14532,7 +14803,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 415, + "weight": 827, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -14601,7 +14872,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 411, + "weight": 823, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -14674,7 +14945,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 412, + "weight": 824, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -14740,7 +15011,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 413, + "weight": 825, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -14820,7 +15091,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 414, + "weight": 826, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -14888,7 +15159,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 416, + "weight": 828, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -14974,7 +15245,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 382, + "weight": 794, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -15036,7 +15307,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 383, + "weight": 795, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -15115,7 +15386,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 384, + "weight": 796, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -15179,7 +15450,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 392, + "weight": 804, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -15276,7 +15547,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 388, + "weight": 800, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -15400,7 +15671,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 389, + "weight": 801, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -15472,7 +15743,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 390, + "weight": 802, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -15548,6 +15819,11 @@ "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false } }, "required": [ @@ -15574,7 +15850,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 391, + "weight": 803, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -15648,7 +15924,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 407, + "weight": 819, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -15770,7 +16046,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 399, + "weight": 811, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -15949,7 +16225,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 404, + "weight": 816, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -16079,7 +16355,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 402, + "weight": 814, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -16180,7 +16456,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 406, + "weight": 818, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -16278,7 +16554,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 400, + "weight": 812, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -16387,7 +16663,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 403, + "weight": 815, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -16535,7 +16811,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 401, + "weight": 813, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -16643,7 +16919,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 405, + "weight": 817, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -16747,7 +17023,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 410, + "weight": 822, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -16872,7 +17148,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 409, + "weight": 821, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -16997,7 +17273,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 398, + "weight": 810, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -17093,7 +17369,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 395, + "weight": 807, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -17159,8 +17435,7 @@ "enum": [ "key", "fulltext", - "unique", - "spatial" + "unique" ], "x-enum-name": "DocumentsDBIndexType", "x-enum-keys": [] @@ -17231,7 +17506,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 396, + "weight": 808, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -17305,7 +17580,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 397, + "weight": 809, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -17388,7 +17663,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 468, + "weight": 463, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -17474,7 +17749,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 628, + "weight": 864, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -17571,6 +17846,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -17608,7 +17884,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -17728,6 +18005,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -17819,7 +18100,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 470, + "weight": 465, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -17870,7 +18151,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 471, + "weight": 466, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -17921,7 +18202,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 466, + "weight": 461, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -17982,7 +18263,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 629, + "weight": 865, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -18086,6 +18367,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -18123,7 +18405,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -18243,6 +18526,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -18324,7 +18611,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 469, + "weight": 464, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -18387,7 +18674,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 474, + "weight": 469, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -18469,7 +18756,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 475, + "weight": 470, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -18565,7 +18852,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 472, + "weight": 467, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -18666,7 +18953,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 480, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -18753,7 +19040,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 477, + "weight": 472, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -18871,7 +19158,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 478, + "weight": 473, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -18970,7 +19257,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 473, + "weight": 468, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -19034,7 +19321,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 476, + "weight": 471, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -19100,7 +19387,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 479, + "weight": 474, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -19192,7 +19479,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 481, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -19265,7 +19552,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 484, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -19354,7 +19641,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 482, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -19474,7 +19761,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 483, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -19542,7 +19829,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 485, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -19615,7 +19902,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 490, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -19676,7 +19963,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 630, + "weight": 866, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -19769,7 +20056,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 489, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -19840,7 +20127,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 491, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -19935,7 +20222,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 492, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -20008,7 +20295,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 150, + "weight": 140, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -20064,7 +20351,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 149, + "weight": 139, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -20120,7 +20407,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 495, + "weight": 490, "cookies": false, "type": "", "demo": "health\/get.md", @@ -20172,7 +20459,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 504, + "weight": 499, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -20224,7 +20511,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 498, + "weight": 493, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -20276,7 +20563,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 501, + "weight": 496, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -20339,7 +20626,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 762, + "weight": 1004, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -20415,7 +20702,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 497, + "weight": 492, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -20467,7 +20754,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 499, + "weight": 494, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -20502,7 +20789,7 @@ "tags": [ "health" ], - "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.", + "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.\n", "responses": { "200": { "description": "Health Queue", @@ -20519,7 +20806,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 505, + "weight": 500, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -20584,7 +20871,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 758, + "weight": 1000, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -20649,7 +20936,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 757, + "weight": 999, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -20714,7 +21001,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 509, + "weight": 504, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -20779,7 +21066,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 759, + "weight": 1001, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -20844,7 +21131,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 508, + "weight": 503, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -20909,7 +21196,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 510, + "weight": 505, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -20985,7 +21272,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 511, + "weight": 506, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -21050,7 +21337,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 518, + "weight": 513, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -21142,7 +21429,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 515, + "weight": 510, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -21207,7 +21494,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 507, + "weight": 502, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -21272,7 +21559,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 512, + "weight": 507, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -21337,7 +21624,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 513, + "weight": 508, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -21402,7 +21689,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 514, + "weight": 509, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -21467,7 +21754,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 760, + "weight": 1002, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -21532,7 +21819,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 516, + "weight": 511, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -21597,7 +21884,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 517, + "weight": 512, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -21662,7 +21949,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 761, + "weight": 1003, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -21727,7 +22014,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 506, + "weight": 501, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -21792,7 +22079,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 503, + "weight": 498, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -21844,7 +22131,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 502, + "weight": 497, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -21896,7 +22183,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 500, + "weight": 495, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -22396,7 +22683,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 205, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -22485,7 +22772,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 202, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -22593,7 +22880,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -22632,7 +22920,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 209, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -22748,7 +23036,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "attachments": { @@ -22791,7 +23080,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 204, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -22912,7 +23201,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -22970,7 +23260,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 211, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -23111,7 +23401,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -23169,7 +23460,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 203, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -23315,7 +23606,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -23353,7 +23645,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 210, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -23509,7 +23801,8 @@ "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -23543,7 +23836,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 208, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -23598,7 +23891,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 212, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -23662,7 +23955,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 206, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -23750,7 +24043,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 207, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -23838,7 +24131,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 176, + "weight": 168, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -23927,7 +24220,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 175, + "weight": 167, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -24109,7 +24402,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 189, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -24293,7 +24586,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 174, + "weight": 166, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -24448,7 +24741,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 188, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -24604,7 +24897,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 165, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -24725,7 +25018,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 179, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -24848,7 +25141,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 169, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -24946,7 +25239,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 183, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -25047,7 +25340,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 167, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -25157,7 +25450,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 181, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -25269,7 +25562,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 166, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -25379,7 +25672,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 180, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -25491,7 +25784,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 168, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -25728,7 +26021,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 182, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -25964,7 +26257,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 170, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -26063,7 +26356,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 184, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -26164,7 +26457,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 171, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -26263,7 +26556,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 185, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -26364,7 +26657,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 172, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -26463,7 +26756,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 186, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -26564,7 +26857,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 173, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -26663,7 +26956,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 187, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -26764,7 +27057,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 178, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -26819,7 +27112,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 190, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -26883,7 +27176,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 177, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -26971,7 +27264,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 199, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -27059,7 +27352,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 192, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -27146,7 +27439,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 191, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -27231,7 +27524,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 194, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -27293,7 +27586,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 195, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -27374,7 +27667,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 196, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -27438,7 +27731,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 193, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -27526,7 +27819,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 198, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -27623,7 +27916,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 197, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -27716,7 +28009,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 200, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -27781,7 +28074,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 201, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -27835,21 +28128,21 @@ ] } }, - "\/project\/variables": { - "get": { - "summary": "List project variables", - "operationId": "projectListVariables", + "\/project\/auth\/canonical-emails": { + "patch": { + "summary": "Update project auth canonical emails", + "operationId": "projectUpdateCanonicalEmails", "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", "responses": { "200": { - "description": "Variables List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variableList" + "$ref": "#\/components\/schemas\/project" } } } @@ -27857,16 +28150,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 623, + "method": "updateCanonicalEmails", + "group": "auth", + "weight": 1072, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/update-canonical-emails.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "project.write", "platforms": [ "console", "server" @@ -27884,47 +28177,112 @@ "Key": [] } ], - "parameters": [ - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to require canonical email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/auth\/disposable-emails": { + "patch": { + "summary": "Update project auth disposable emails", + "operationId": "projectUpdateDisposableEmails", + "tags": [ + "project" + ], + "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDisposableEmails", + "group": "auth", + "weight": 1073, + "cookies": false, + "type": "", + "demo": "project\/update-disposable-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" + "Project": [], + "Key": [] } - ] - }, - "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/auth\/free-emails": { + "patch": { + "summary": "Update project auth free emails", + "operationId": "projectUpdateFreeEmails", "tags": [ "project" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/project" } } } @@ -27932,12 +28290,1826 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 622, + "method": "updateFreeEmails", + "group": "auth", + "weight": 1074, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/update-free-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/keys": { + "get": { + "summary": "List project keys", + "operationId": "projectListKeys", + "tags": [ + "project" + ], + "description": "Get a list of all API keys from the current project.", + "responses": { + "200": { + "description": "API Keys List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/keyList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listKeys", + "group": "keys", + "weight": 1055, + "cookies": false, + "type": "", + "demo": "project\/list-keys.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire, accessedAt, name, scopes", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create project key", + "operationId": "projectCreateKey", + "tags": [ + "project" + ], + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "responses": { + "201": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createKey", + "group": "keys", + "weight": 1054, + "cookies": false, + "type": "", + "demo": "project\/create-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "keyId": { + "type": "string", + "description": "Key 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": "Key name. Max length: 128 chars.", + "x-example": "" + }, + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "x-nullable": true + }, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + } + }, + "required": [ + "keyId", + "name", + "scopes" + ] + } + } + } + } + } + }, + "\/project\/keys\/{keyId}": { + "get": { + "summary": "Get project key", + "operationId": "projectGetKey", + "tags": [ + "project" + ], + "description": "Get a key by its unique ID. ", + "responses": { + "200": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getKey", + "group": "keys", + "weight": 1056, + "cookies": false, + "type": "", + "demo": "project\/get-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "keyId", + "description": "Key ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update project key", + "operationId": "projectUpdateKey", + "tags": [ + "project" + ], + "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.", + "responses": { + "200": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateKey", + "group": "keys", + "weight": 1058, + "cookies": false, + "type": "", + "demo": "project\/update-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "keyId", + "description": "Key ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Key name. Max length: 128 chars.", + "x-example": "" + }, + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "x-nullable": true + }, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + } + }, + "required": [ + "name", + "scopes" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete project key", + "operationId": "projectDeleteKey", + "tags": [ + "project" + ], + "description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteKey", + "group": "keys", + "weight": 1057, + "cookies": false, + "type": "", + "demo": "project\/delete-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "keyId", + "description": "Key ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/project\/labels": { + "put": { + "summary": "Update project labels", + "operationId": "projectUpdateLabels", + "tags": [ + "project" + ], + "description": "Update the project labels. Labels can be used to easily filter projects in an organization.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateLabels", + "group": null, + "weight": 1048, + "cookies": false, + "type": "", + "demo": "project\/update-labels.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "labels": { + "type": "array", + "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + }, + "required": [ + "labels" + ] + } + } + } + } + } + }, + "\/project\/platforms": { + "get": { + "summary": "List project platforms", + "operationId": "projectListPlatforms", + "tags": [ + "project" + ], + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "responses": { + "200": { + "description": "Platforms List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listPlatforms", + "group": "platforms", + "weight": 1071, + "cookies": false, + "type": "", + "demo": "project\/list-platforms.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/project\/platforms\/android": { + "post": { + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", + "tags": [ + "project" + ], + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Android", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformAndroid" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1067, + "cookies": false, + "type": "", + "demo": "project\/create-android-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "applicationId" + ] + } + } + } + } + } + }, + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", + "tags": [ + "project" + ], + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", + "responses": { + "200": { + "description": "Platform Android", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformAndroid" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1062, + "cookies": false, + "type": "", + "demo": "project\/update-android-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } + } + } + } + } + }, + "\/project\/platforms\/apple": { + "post": { + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", + "tags": [ + "project" + ], + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Apple", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformApple" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createApplePlatform", + "group": "platforms", + "weight": 1066, + "cookies": false, + "type": "", + "demo": "project\/create-apple-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "bundleIdentifier" + ] + } + } + } + } + } + }, + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", + "tags": [ + "project" + ], + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", + "responses": { + "200": { + "description": "Platform Apple", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformApple" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1061, + "cookies": false, + "type": "", + "demo": "project\/update-apple-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } + } + } + } + } + }, + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", + "tags": [ + "project" + ], + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Linux", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformLinux" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1069, + "cookies": false, + "type": "", + "demo": "project\/create-linux-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageName" + ] + } + } + } + } + } + }, + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", + "tags": [ + "project" + ], + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", + "responses": { + "200": { + "description": "Platform Linux", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformLinux" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1064, + "cookies": false, + "type": "", + "demo": "project\/update-linux-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "packageName" + ] + } + } + } + } + } + }, + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", + "tags": [ + "project" + ], + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Web", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformWeb" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createWebPlatform", + "group": "platforms", + "weight": 1065, + "cookies": false, + "type": "", + "demo": "project\/create-web-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": null + } + }, + "required": [ + "platformId", + "name" + ] + } + } + } + } + } + }, + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", + "tags": [ + "project" + ], + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", + "responses": { + "200": { + "description": "Platform Web", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformWeb" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1060, + "cookies": false, + "type": "", + "demo": "project\/update-web-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": null + } + }, + "required": [ + "name" + ] + } + } + } + } + } + }, + "\/project\/platforms\/windows": { + "post": { + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", + "tags": [ + "project" + ], + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Windows", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformWindows" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1068, + "cookies": false, + "type": "", + "demo": "project\/create-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageIdentifierName" + ] + } + } + } + } + } + }, + "\/project\/platforms\/windows\/{platformId}": { + "put": { + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", + "tags": [ + "project" + ], + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", + "responses": { + "200": { + "description": "Platform Windows", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformWindows" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1063, + "cookies": false, + "type": "", + "demo": "project\/update-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "packageIdentifierName" + ] + } + } + } + } + } + }, + "\/project\/platforms\/{platformId}": { + "get": { + "summary": "Get project platform", + "operationId": "projectGetPlatform", + "tags": [ + "project" + ], + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", + "responses": { + "200": { + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getPlatform", + "group": "platforms", + "weight": 1070, + "cookies": false, + "type": "", + "demo": "project\/get-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", + "tags": [ + "project" + ], + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deletePlatform", + "group": "platforms", + "weight": 1059, + "cookies": false, + "type": "", + "demo": "project\/delete-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/project\/variables": { + "get": { + "summary": "List project variables", + "operationId": "projectListVariables", + "tags": [ + "project" + ], + "description": "Get a list of all project environment variables.", + "responses": { + "200": { + "description": "Variables List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variableList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listVariables", + "group": "variables", + "weight": 1050, + "cookies": false, + "type": "", + "demo": "project\/list-variables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create project variable", + "operationId": "projectCreateVariable", + "tags": [ + "project" + ], + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "responses": { + "201": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createVariable", + "group": "variables", + "weight": 1049, + "cookies": false, + "type": "", + "demo": "project\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -27987,7 +30159,6 @@ } }, "required": [ - "variableId", "key", "value" ] @@ -28021,7 +30192,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 624, + "weight": 1051, "cookies": false, "type": "", "demo": "project\/get-variable.md", @@ -28082,7 +30253,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 626, + "weight": 1053, "cookies": false, "type": "", "demo": "project\/update-variable.md", @@ -28165,7 +30336,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 625, + "weight": 1052, "cookies": false, "type": "", "demo": "project\/delete-variable.md", @@ -28228,7 +30399,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 522, + "weight": 517, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -28314,7 +30485,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 631, + "weight": 867, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -28471,6 +30642,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -28508,7 +30680,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -28607,7 +30780,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 525, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -28658,7 +30831,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 548, + "weight": 543, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -28709,7 +30882,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 521, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -28770,7 +30943,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 632, + "weight": 868, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -28934,6 +31107,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -28971,7 +31145,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -29059,7 +31234,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 524, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -29122,7 +31297,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 531, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -29204,7 +31379,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 530, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -29300,7 +31475,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 526, + "weight": 521, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -29406,7 +31581,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 534, + "weight": 529, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -29488,7 +31663,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 527, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -29606,7 +31781,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 528, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -29706,7 +31881,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 529, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -29770,7 +31945,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 532, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -29836,7 +32011,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 533, + "weight": 528, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -29928,7 +32103,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 535, + "weight": 530, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -30001,7 +32176,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 537, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -30088,7 +32263,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 536, + "weight": 531, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -30152,7 +32327,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 538, + "weight": 533, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -30225,7 +32400,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 541, + "weight": 536, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -30286,7 +32461,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 633, + "weight": 869, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -30379,7 +32554,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 540, + "weight": 535, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -30450,7 +32625,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 542, + "weight": 537, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -30545,7 +32720,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 543, + "weight": 538, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -30618,7 +32793,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 589, + "weight": 584, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -30705,7 +32880,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 587, + "weight": 582, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -30842,7 +33017,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 588, + "weight": 583, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -30904,7 +33079,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 590, + "weight": 585, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -31038,7 +33213,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 591, + "weight": 586, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -31102,7 +33277,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 594, + "weight": 589, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -31203,7 +33378,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 808, + "weight": 1077, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -31307,7 +33482,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 593, + "weight": 588, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -31383,7 +33558,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 595, + "weight": 590, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -31477,7 +33652,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 596, + "weight": 591, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -31548,7 +33723,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 598, + "weight": 593, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -31630,7 +33805,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 597, + "weight": 592, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -31862,7 +34037,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 599, + "weight": 594, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -31951,7 +34126,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 312, + "weight": 722, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -32038,7 +34213,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 308, + "weight": 718, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -32120,7 +34295,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 379, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -32192,7 +34367,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 375, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -32268,7 +34443,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 376, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -32337,7 +34512,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 377, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -32420,7 +34595,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 378, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -32491,7 +34666,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 380, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -32581,7 +34756,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 309, + "weight": 719, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -32643,7 +34818,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 310, + "weight": 720, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -32719,7 +34894,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 311, + "weight": 721, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -32783,7 +34958,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 319, + "weight": 729, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -32883,7 +35058,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 315, + "weight": 725, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -33010,7 +35185,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 316, + "weight": 726, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -33085,7 +35260,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 317, + "weight": 727, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -33165,6 +35340,11 @@ "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 + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false } } } @@ -33188,7 +35368,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 318, + "weight": 728, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -33265,7 +35445,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 324, + "weight": 734, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -33316,30 +35496,291 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", - "required": false, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBigint" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 747, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "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, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", + "tags": [ + "tablesDB" + ], + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnBigInt", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnBigint" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateBigIntColumn", + "group": "columns", + "weight": 748, + "cookies": false, + "type": "", + "demo": "tablesdb\/update-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", + "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": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "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, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { @@ -33366,7 +35807,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 325, + "weight": 735, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -33479,7 +35920,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 326, + "weight": 736, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -33597,7 +36038,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 327, + "weight": 737, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -33667,7 +36108,8 @@ "default": { "type": "string", "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -33710,7 +36152,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 328, + "weight": 738, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -33784,7 +36226,8 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { @@ -33828,7 +36271,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 329, + "weight": 739, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -33942,7 +36385,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 330, + "weight": 740, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -34061,7 +36504,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 331, + "weight": 741, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -34183,7 +36626,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 332, + "weight": 742, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -34310,7 +36753,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 333, + "weight": 743, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -34438,7 +36881,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 334, + "weight": 744, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -34571,7 +37014,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 335, + "weight": 745, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -34699,7 +37142,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 336, + "weight": 746, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -34832,7 +37275,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 337, + "weight": 749, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -34945,7 +37388,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 338, + "weight": 750, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -35063,7 +37506,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 339, + "weight": 751, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -35178,7 +37621,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 340, + "weight": 752, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -35302,7 +37745,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 357, + "weight": 769, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -35420,7 +37863,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 358, + "weight": 770, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -35538,7 +37981,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 355, + "weight": 767, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -35656,7 +38099,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 356, + "weight": 768, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -35774,7 +38217,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 341, + "weight": 753, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -35889,7 +38332,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 342, + "weight": 754, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -36013,7 +38456,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 343, + "weight": 755, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -36128,7 +38571,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 344, + "weight": 756, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -36252,7 +38695,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 345, + "weight": 757, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -36391,7 +38834,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 347, + "weight": 759, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -36520,7 +38963,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 348, + "weight": 760, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -36649,7 +39092,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 353, + "weight": 765, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -36767,7 +39210,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 354, + "weight": 766, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -36885,7 +39328,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 349, + "weight": 761, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -36999,7 +39442,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 350, + "weight": 762, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -37118,7 +39561,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 351, + "weight": 763, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -37243,7 +39686,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 352, + "weight": 764, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -37399,7 +39842,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 322, + "weight": 732, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -37476,7 +39919,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 323, + "weight": 733, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -37562,7 +40005,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 346, + "weight": 758, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -37678,7 +40121,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 362, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -37777,7 +40220,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 359, + "weight": 771, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -37918,7 +40361,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 360, + "weight": 772, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -37995,7 +40438,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 361, + "weight": 773, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -38081,7 +40524,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 371, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -38171,7 +40614,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "schema": { "type": "integer", @@ -38206,7 +40649,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 363, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -38392,7 +40835,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 368, + "weight": 780, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -38526,7 +40969,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 366, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -38631,7 +41074,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 370, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -38733,7 +41176,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 364, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -38845,7 +41288,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 367, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -38998,7 +41441,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 365, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -39111,7 +41554,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 369, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -39219,7 +41662,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 374, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -39349,7 +41792,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 373, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -39479,7 +41922,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 570, + "weight": 565, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -39570,7 +42013,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 568, + "weight": 563, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -39659,7 +42102,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 569, + "weight": 564, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -39725,7 +42168,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 572, + "weight": 567, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -39803,7 +42246,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 571, + "weight": 566, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -39871,7 +42314,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 577, + "weight": 572, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -39972,7 +42415,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 575, + "weight": 570, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -40090,7 +42533,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 576, + "weight": 571, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -40166,7 +42609,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 578, + "weight": 573, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -40257,7 +42700,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 809, + "weight": 1078, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -40335,7 +42778,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 580, + "weight": 575, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -40436,7 +42879,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 573, + "weight": 568, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -40500,7 +42943,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 574, + "weight": 569, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -40585,7 +43028,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 584, + "weight": 579, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -40680,7 +43123,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 582, + "weight": 577, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -40736,7 +43179,8 @@ "expire": { "type": "string", "description": "Token expiry date", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -40770,7 +43214,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 583, + "weight": 578, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -40831,7 +43275,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 585, + "weight": 580, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -40877,7 +43321,8 @@ "expire": { "type": "string", "description": "File token expiry date", - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -40902,7 +43347,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 586, + "weight": 581, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -40965,7 +43410,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 104, + "weight": 94, "cookies": false, "type": "", "demo": "users\/list.md", @@ -41052,7 +43497,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 95, + "weight": 85, "cookies": false, "type": "", "demo": "users\/create.md", @@ -41147,7 +43592,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 98, + "weight": 88, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -41237,7 +43682,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 96, + "weight": 86, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -41327,7 +43772,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 112, + "weight": 102, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -41409,7 +43854,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 136, + "weight": 126, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -41473,7 +43918,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 97, + "weight": 87, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -41563,7 +44008,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 100, + "weight": 90, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -41653,7 +44098,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 101, + "weight": 91, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -41777,7 +44222,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 102, + "weight": 92, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -41885,7 +44330,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 99, + "weight": 89, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -41995,7 +44440,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 105, + "weight": 95, "cookies": false, "type": "", "demo": "users\/get.md", @@ -42050,7 +44495,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 134, + "weight": 124, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -42114,7 +44559,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 119, + "weight": 109, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -42198,7 +44643,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 115, + "weight": 105, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -42281,7 +44726,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 137, + "weight": 127, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -42367,7 +44812,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 114, + "weight": 104, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -42453,7 +44898,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 110, + "weight": 100, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -42541,7 +44986,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 109, + "weight": 99, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -42640,7 +45085,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 124, + "weight": 114, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -42778,7 +45223,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 129, + "weight": 119, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -42917,7 +45362,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 125, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -43039,7 +45484,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 126, + "weight": 116, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -43159,7 +45604,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 128, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -43279,7 +45724,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 127, + "weight": 117, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -43401,7 +45846,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 117, + "weight": 107, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -43484,7 +45929,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 118, + "weight": 108, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -43567,7 +46012,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 120, + "weight": 110, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -43651,7 +46096,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 106, + "weight": 96, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -43713,7 +46158,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 122, + "weight": 112, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -43796,7 +46241,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 108, + "weight": 98, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -43869,7 +46314,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 130, + "weight": 120, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -43924,7 +46369,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 133, + "weight": 123, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -43981,7 +46426,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 132, + "weight": 122, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -44055,7 +46500,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 113, + "weight": 103, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -44138,7 +46583,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 111, + "weight": 101, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -44224,7 +46669,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 103, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -44336,7 +46781,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 107, + "weight": 97, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -44408,7 +46853,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 123, + "weight": 113, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -44499,7 +46944,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 135, + "weight": 125, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -44573,7 +47018,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 131, + "weight": 121, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -44660,7 +47105,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 121, + "weight": 111, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -44743,7 +47188,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 116, + "weight": 106, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -44826,7 +47271,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 421, + "weight": 833, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -44913,7 +47358,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 417, + "weight": 829, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -44995,7 +47440,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 445, + "weight": 857, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -45108,7 +47553,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 450, + "weight": 862, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -45177,7 +47622,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 446, + "weight": 858, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -45250,7 +47695,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 447, + "weight": 859, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -45316,7 +47761,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 448, + "weight": 860, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -45396,7 +47841,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 449, + "weight": 861, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -45464,7 +47909,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 451, + "weight": 863, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -45551,7 +47996,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 418, + "weight": 830, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -45613,7 +48058,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 419, + "weight": 831, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -45692,7 +48137,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 420, + "weight": 832, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -45756,7 +48201,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 428, + "weight": 840, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -45853,7 +48298,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 424, + "weight": 836, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -45967,7 +48412,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 425, + "weight": 837, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -46039,7 +48484,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 426, + "weight": 838, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -46147,7 +48592,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 427, + "weight": 839, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -46221,7 +48666,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 439, + "weight": 851, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -46343,7 +48788,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 435, + "weight": 847, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -46522,7 +48967,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 442, + "weight": 854, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -46652,7 +49097,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 441, + "weight": 853, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -46753,7 +49198,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 443, + "weight": 855, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -46851,7 +49296,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 438, + "weight": 850, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -46960,7 +49405,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 437, + "weight": 849, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -47108,7 +49553,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 436, + "weight": 848, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -47216,7 +49661,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 440, + "weight": 852, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -47320,7 +49765,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 434, + "weight": 846, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -47416,7 +49861,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 431, + "weight": 843, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -47556,7 +50001,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 432, + "weight": 844, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -47630,7 +50075,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 433, + "weight": 845, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -47713,7 +50158,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 617, + "weight": 612, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -47788,7 +50233,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 616, + "weight": 611, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -47899,7 +50344,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 618, + "weight": 613, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -47960,7 +50405,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 620, + "weight": 615, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -48068,7 +50513,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 619, + "weight": 614, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -48131,7 +50576,7 @@ "x-appwrite": { "method": "updateSignature", "group": null, - "weight": 621, + "weight": 616, "cookies": false, "type": "", "demo": "webhooks\/update-signature.md", @@ -48935,6 +51380,34 @@ "webhooks": "" } }, + "keyList": { + "description": "API Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of keys that matched your query.", + "x-example": 5, + "format": "int32" + }, + "keys": { + "type": "array", + "description": "List of keys.", + "items": { + "$ref": "#\/components\/schemas\/key" + }, + "x-example": "" + } + }, + "required": [ + "total", + "keys" + ], + "example": { + "total": 5, + "keys": "" + } + }, "countryList": { "description": "Countries List", "type": "object", @@ -49597,6 +52070,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -49719,6 +52195,9 @@ { "$ref": "#\/components\/schemas\/attributeBoolean" }, + { + "$ref": "#\/components\/schemas\/attributeBigint" + }, { "$ref": "#\/components\/schemas\/attributeInteger" }, @@ -49975,6 +52454,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for 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" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -51726,6 +54303,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -51848,6 +54428,9 @@ { "$ref": "#\/components\/schemas\/columnBoolean" }, + { + "$ref": "#\/components\/schemas\/columnBigint" + }, { "$ref": "#\/components\/schemas\/columnInteger" }, @@ -52104,6 +54687,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int32", + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -53879,6 +56560,11 @@ "description": "API mode when event triggered.", "x-example": "admin" }, + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" + }, "ip": { "type": "string", "description": "IP session in use when the session was created.", @@ -53966,6 +56652,7 @@ "userEmail", "userName", "mode", + "userType", "ip", "time", "osCode", @@ -53989,6 +56676,7 @@ "userEmail": "john@appwrite.io", "userName": "John Doe", "mode": "admin", + "userType": "user", "ip": "127.0.0.1", "time": "2020-10-15T06:38:00.000+00:00", "osCode": "Mac", @@ -56382,6 +59070,574 @@ "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, + "project": { + "description": "Project", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Project ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Project creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Project update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Project name.", + "x-example": "New Project" + }, + "description": { + "type": "string", + "description": "Project description.", + "x-example": "This is a new project." + }, + "teamId": { + "type": "string", + "description": "Project team ID.", + "x-example": "1592981250" + }, + "logo": { + "type": "string", + "description": "Project logo file ID.", + "x-example": "5f5c451b403cb" + }, + "url": { + "type": "string", + "description": "Project website URL.", + "x-example": "5f5c451b403cb" + }, + "legalName": { + "type": "string", + "description": "Company legal name.", + "x-example": "Company LTD." + }, + "legalCountry": { + "type": "string", + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", + "x-example": "US" + }, + "legalState": { + "type": "string", + "description": "State name.", + "x-example": "New York" + }, + "legalCity": { + "type": "string", + "description": "City name.", + "x-example": "New York City." + }, + "legalAddress": { + "type": "string", + "description": "Company Address.", + "x-example": "620 Eighth Avenue, New York, NY 10018" + }, + "legalTaxId": { + "type": "string", + "description": "Company Tax ID.", + "x-example": "131102020" + }, + "authDuration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 60, + "format": "int32" + }, + "authLimit": { + "type": "integer", + "description": "Max users allowed. 0 is unlimited.", + "x-example": 100, + "format": "int32" + }, + "authSessionsLimit": { + "type": "integer", + "description": "Max sessions allowed per user. 100 maximum.", + "x-example": 10, + "format": "int32" + }, + "authPasswordHistory": { + "type": "integer", + "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", + "x-example": 5, + "format": "int32" + }, + "authPasswordDictionary": { + "type": "boolean", + "description": "Whether or not to check user's password against most commonly used passwords.", + "x-example": true + }, + "authPersonalDataCheck": { + "type": "boolean", + "description": "Whether or not to check the user password for similarity with their personal data.", + "x-example": true + }, + "authDisposableEmails": { + "type": "boolean", + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true + }, + "authCanonicalEmails": { + "type": "boolean", + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true + }, + "authFreeEmails": { + "type": "boolean", + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true + }, + "authMockNumbers": { + "type": "array", + "description": "An array of mock numbers and their corresponding verification codes (OTPs).", + "items": { + "$ref": "#\/components\/schemas\/mockNumber" + }, + "x-example": [ + {} + ] + }, + "authSessionAlerts": { + "type": "boolean", + "description": "Whether or not to send session alert emails to users.", + "x-example": true + }, + "authMembershipsUserName": { + "type": "boolean", + "description": "Whether or not to show user names in the teams membership response.", + "x-example": true + }, + "authMembershipsUserEmail": { + "type": "boolean", + "description": "Whether or not to show user emails in the teams membership response.", + "x-example": true + }, + "authMembershipsMfa": { + "type": "boolean", + "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.", + "items": { + "$ref": "#\/components\/schemas\/authProvider" + }, + "x-example": [ + {} + ] + }, + "platforms": { + "type": "array", + "description": "List of Platforms.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ] + }, + "x-example": {} + }, + "webhooks": { + "type": "array", + "description": "List of Webhooks.", + "items": { + "$ref": "#\/components\/schemas\/webhook" + }, + "x-example": {} + }, + "keys": { + "type": "array", + "description": "List of API Keys.", + "items": { + "$ref": "#\/components\/schemas\/key" + }, + "x-example": {} + }, + "devKeys": { + "type": "array", + "description": "List of dev keys.", + "items": { + "$ref": "#\/components\/schemas\/devKey" + }, + "x-example": {} + }, + "smtpEnabled": { + "type": "boolean", + "description": "Status for custom SMTP", + "x-example": false + }, + "smtpSenderName": { + "type": "string", + "description": "SMTP sender name", + "x-example": "John Appwrite" + }, + "smtpSenderEmail": { + "type": "string", + "description": "SMTP sender email", + "x-example": "john@appwrite.io" + }, + "smtpReplyTo": { + "type": "string", + "description": "SMTP reply to email", + "x-example": "support@appwrite.io" + }, + "smtpHost": { + "type": "string", + "description": "SMTP server host name", + "x-example": "mail.appwrite.io" + }, + "smtpPort": { + "type": "integer", + "description": "SMTP server port", + "x-example": 25, + "format": "int32" + }, + "smtpUsername": { + "type": "string", + "description": "SMTP server username", + "x-example": "emailuser" + }, + "smtpPassword": { + "type": "string", + "description": "SMTP server password", + "x-example": "securepassword" + }, + "smtpSecure": { + "type": "string", + "description": "SMTP server secure protocol", + "x-example": "tls" + }, + "pingCount": { + "type": "integer", + "description": "Number of times the ping was received for this project.", + "x-example": 1, + "format": "int32" + }, + "pingedAt": { + "type": "string", + "description": "Last ping datetime in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "labels": { + "type": "array", + "description": "Labels for the project.", + "items": { + "type": "string" + }, + "x-example": [ + "vip" + ] + }, + "status": { + "type": "string", + "description": "Project status", + "x-example": "active" + }, + "authEmailPassword": { + "type": "boolean", + "description": "Email\/Password auth method status", + "x-example": true + }, + "authUsersAuthMagicURL": { + "type": "boolean", + "description": "Magic URL auth method status", + "x-example": true + }, + "authEmailOtp": { + "type": "boolean", + "description": "Email (OTP) auth method status", + "x-example": true + }, + "authAnonymous": { + "type": "boolean", + "description": "Anonymous auth method status", + "x-example": true + }, + "authInvites": { + "type": "boolean", + "description": "Invites auth method status", + "x-example": true + }, + "authJWT": { + "type": "boolean", + "description": "JWT auth method status", + "x-example": true + }, + "authPhone": { + "type": "boolean", + "description": "Phone auth method status", + "x-example": true + }, + "serviceStatusForAccount": { + "type": "boolean", + "description": "Account service status", + "x-example": true + }, + "serviceStatusForAvatars": { + "type": "boolean", + "description": "Avatars service status", + "x-example": true + }, + "serviceStatusForDatabases": { + "type": "boolean", + "description": "Databases (legacy) service status", + "x-example": true + }, + "serviceStatusForTablesdb": { + "type": "boolean", + "description": "TablesDB service status", + "x-example": true + }, + "serviceStatusForLocale": { + "type": "boolean", + "description": "Locale service status", + "x-example": true + }, + "serviceStatusForHealth": { + "type": "boolean", + "description": "Health service status", + "x-example": true + }, + "serviceStatusForStorage": { + "type": "boolean", + "description": "Storage service status", + "x-example": true + }, + "serviceStatusForTeams": { + "type": "boolean", + "description": "Teams service status", + "x-example": true + }, + "serviceStatusForUsers": { + "type": "boolean", + "description": "Users service status", + "x-example": true + }, + "serviceStatusForSites": { + "type": "boolean", + "description": "Sites service status", + "x-example": true + }, + "serviceStatusForFunctions": { + "type": "boolean", + "description": "Functions service status", + "x-example": true + }, + "serviceStatusForGraphql": { + "type": "boolean", + "description": "GraphQL service status", + "x-example": true + }, + "serviceStatusForMessaging": { + "type": "boolean", + "description": "Messaging service status", + "x-example": true + }, + "region": { + "type": "string", + "description": "Project region", + "x-example": "fra" + }, + "billingLimits": { + "type": "object", + "description": "Billing limits reached", + "x-example": "", + "items": { + "$ref": "#\/components\/schemas\/billingLimits" + } + }, + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "$ref": "#\/components\/schemas\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { + "type": "string", + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "description", + "teamId", + "logo", + "url", + "legalName", + "legalCountry", + "legalState", + "legalCity", + "legalAddress", + "legalTaxId", + "authDuration", + "authLimit", + "authSessionsLimit", + "authPasswordHistory", + "authPasswordDictionary", + "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", + "authMockNumbers", + "authSessionAlerts", + "authMembershipsUserName", + "authMembershipsUserEmail", + "authMembershipsMfa", + "authInvalidateSessions", + "oAuthProviders", + "platforms", + "webhooks", + "keys", + "devKeys", + "smtpEnabled", + "smtpSenderName", + "smtpSenderEmail", + "smtpReplyTo", + "smtpHost", + "smtpPort", + "smtpUsername", + "smtpPassword", + "smtpSecure", + "pingCount", + "pingedAt", + "labels", + "status", + "authEmailPassword", + "authUsersAuthMagicURL", + "authEmailOtp", + "authAnonymous", + "authInvites", + "authJWT", + "authPhone", + "serviceStatusForAccount", + "serviceStatusForAvatars", + "serviceStatusForDatabases", + "serviceStatusForTablesdb", + "serviceStatusForLocale", + "serviceStatusForHealth", + "serviceStatusForStorage", + "serviceStatusForTeams", + "serviceStatusForUsers", + "serviceStatusForSites", + "serviceStatusForFunctions", + "serviceStatusForGraphql", + "serviceStatusForMessaging", + "region", + "billingLimits", + "blocks", + "consoleAccessedAt" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "New Project", + "description": "This is a new project.", + "teamId": "1592981250", + "logo": "5f5c451b403cb", + "url": "5f5c451b403cb", + "legalName": "Company LTD.", + "legalCountry": "US", + "legalState": "New York", + "legalCity": "New York City.", + "legalAddress": "620 Eighth Avenue, New York, NY 10018", + "legalTaxId": "131102020", + "authDuration": 60, + "authLimit": 100, + "authSessionsLimit": 10, + "authPasswordHistory": 5, + "authPasswordDictionary": true, + "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, + "authMockNumbers": [ + {} + ], + "authSessionAlerts": true, + "authMembershipsUserName": true, + "authMembershipsUserEmail": true, + "authMembershipsMfa": true, + "authInvalidateSessions": true, + "oAuthProviders": [ + {} + ], + "platforms": {}, + "webhooks": {}, + "keys": {}, + "devKeys": {}, + "smtpEnabled": false, + "smtpSenderName": "John Appwrite", + "smtpSenderEmail": "john@appwrite.io", + "smtpReplyTo": "support@appwrite.io", + "smtpHost": "mail.appwrite.io", + "smtpPort": 25, + "smtpUsername": "emailuser", + "smtpPassword": "securepassword", + "smtpSecure": "tls", + "pingCount": 1, + "pingedAt": "2020-10-15T06:38:00.000+00:00", + "labels": [ + "vip" + ], + "status": "active", + "authEmailPassword": true, + "authUsersAuthMagicURL": true, + "authEmailOtp": true, + "authAnonymous": true, + "authInvites": true, + "authJWT": true, + "authPhone": true, + "serviceStatusForAccount": true, + "serviceStatusForAvatars": true, + "serviceStatusForDatabases": true, + "serviceStatusForTablesdb": true, + "serviceStatusForLocale": true, + "serviceStatusForHealth": true, + "serviceStatusForStorage": true, + "serviceStatusForTeams": true, + "serviceStatusForUsers": true, + "serviceStatusForSites": true, + "serviceStatusForFunctions": true, + "serviceStatusForGraphql": true, + "serviceStatusForMessaging": true, + "region": "fra", + "billingLimits": "", + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, "webhook": { "description": "Webhook", "type": "object", @@ -56493,6 +59749,563 @@ "attempts": 10 } }, + "key": { + "description": "Key", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Key ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Key name.", + "x-example": "My API Key" + }, + "expire": { + "type": "string", + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" + }, + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "devKey": { + "description": "DevKey", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Key ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Key name.", + "x-example": "Dev API Key" + }, + "expire": { + "type": "string", + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "secret", + "accessedAt", + "sdks" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Dev API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "mockNumber": { + "description": "Mock Number", + "type": "object", + "properties": { + "phone": { + "type": "string", + "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", + "x-example": "+1612842323" + }, + "otp": { + "type": "string", + "description": "Mock OTP for the number. ", + "x-example": "123456" + } + }, + "required": [ + "phone", + "otp" + ], + "example": { + "phone": "+1612842323", + "otp": "123456" + } + }, + "authProvider": { + "description": "AuthProvider", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Auth Provider.", + "x-example": "github" + }, + "name": { + "type": "string", + "description": "Auth Provider name.", + "x-example": "GitHub" + }, + "appId": { + "type": "string", + "description": "OAuth 2.0 application ID.", + "x-example": "259125845563242502" + }, + "secret": { + "type": "string", + "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.", + "x-example": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ" + }, + "enabled": { + "type": "boolean", + "description": "Auth Provider is active and can be used to create session.", + "x-example": "" + } + }, + "required": [ + "key", + "name", + "appId", + "secret", + "enabled" + ], + "example": { + "key": "github", + "name": "GitHub", + "appId": "259125845563242502", + "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ", + "enabled": "" + } + }, + "platformWeb": { + "description": "Platform Web", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "hostname": { + "type": "string", + "description": "Web app hostname. Empty string for other platforms.", + "x-example": "app.example.com" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "hostname", + "key" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "hostname": "app.example.com" + } + }, + "platformApple": { + "description": "Platform Apple", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "bundleIdentifier" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "bundleIdentifier": "com.company.appname" + } + }, + "platformAndroid": { + "description": "Platform Android", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "applicationId": { + "type": "string", + "description": "Android application ID.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "applicationId" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "applicationId": "com.company.appname" + } + }, + "platformWindows": { + "description": "Platform Windows", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "packageIdentifierName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "packageIdentifierName": "com.company.appname" + } + }, + "platformLinux": { + "description": "Platform Linux", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "packageName": { + "type": "string", + "description": "Linux package name.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "packageName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "packageName": "com.company.appname" + } + }, + "platformList": { + "description": "Platforms List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of platforms in the given project.", + "x-example": 5, + "format": "int32" + }, + "platforms": { + "type": "array", + "description": "List of platforms.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "platforms" + ], + "example": { + "total": 5, + "platforms": "" + } + }, "variable": { "description": "Variable", "type": "object", @@ -57941,6 +61754,125 @@ "resourceType": "database" } }, + "billingLimits": { + "description": "BillingLimits", + "type": "object", + "properties": { + "bandwidth": { + "type": "integer", + "description": "Bandwidth limit", + "x-example": 5, + "format": "int32" + }, + "storage": { + "type": "integer", + "description": "Storage limit", + "x-example": 150, + "format": "int32" + }, + "users": { + "type": "integer", + "description": "Users limit", + "x-example": 200000, + "format": "int32" + }, + "executions": { + "type": "integer", + "description": "Executions limit", + "x-example": 750000, + "format": "int32" + }, + "GBHours": { + "type": "integer", + "description": "GBHours limit", + "x-example": 100, + "format": "int32" + }, + "imageTransformations": { + "type": "integer", + "description": "Image transformations limit", + "x-example": 100, + "format": "int32" + }, + "authPhone": { + "type": "integer", + "description": "Auth phone limit", + "x-example": 10, + "format": "int32" + }, + "budgetLimit": { + "type": "integer", + "description": "Budget limit percentage", + "x-example": 100, + "format": "int32" + } + }, + "required": [ + "bandwidth", + "storage", + "users", + "executions", + "GBHours", + "imageTransformations", + "authPhone", + "budgetLimit" + ], + "example": { + "bandwidth": 5, + "storage": 150, + "users": 200000, + "executions": 750000, + "GBHours": 100, + "imageTransformations": 100, + "authPhone": 10, + "budgetLimit": 100 + } + }, + "block": { + "description": "Block", + "type": "object", + "properties": { + "$createdAt": { + "type": "string", + "description": "Block creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "resourceType": { + "type": "string", + "description": "Resource type that is blocked", + "x-example": "project" + }, + "resourceId": { + "type": "string", + "description": "Resource identifier that is blocked", + "x-example": "5e5ea5c16897e" + }, + "reason": { + "type": "string", + "description": "Reason for the block. Can be null if no reason was provided.", + "x-example": "Payment overdue", + "nullable": true + }, + "expiredAt": { + "type": "string", + "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true + } + }, + "required": [ + "$createdAt", + "resourceType", + "resourceId" + ], + "example": { + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "resourceType": "project", + "resourceId": "5e5ea5c16897e", + "reason": "Payment overdue", + "expiredAt": "2020-10-15T06:38:00.000+00:00" + } + }, "backupPolicy": { "description": "backup", "type": "object", @@ -58264,7 +62196,10 @@ "type": "apiKey", "name": "X-Appwrite-JWT", "description": "Your secret JSON Web Token", - "in": "header" + "in": "header", + "x-appwrite": { + "demo": "" + } }, "Locale": { "type": "apiKey", diff --git a/specs/latest/swagger2-latest-client.json b/specs/latest/swagger2-latest-client.json index f7b989b6..afd20123 100644 --- a/specs/latest/swagger2-latest-client.json +++ b/specs/latest/swagger2-latest-client.json @@ -630,7 +630,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 213, + "weight": 205, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -705,7 +705,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 215, + "weight": 207, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -829,7 +829,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 216, + "weight": 208, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -970,7 +970,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 217, + "weight": 209, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1094,7 +1094,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 221, + "weight": 213, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1231,7 +1231,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 222, + "weight": 214, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1371,7 +1371,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 214, + "weight": 206, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1472,7 +1472,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 220, + "weight": 212, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1573,7 +1573,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 218, + "weight": 210, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1674,7 +1674,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 219, + "weight": 211, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2669,7 +2669,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -2708,6 +2708,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -3625,7 +3626,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -3664,6 +3665,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -4221,7 +4223,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 224, + "weight": 216, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4347,7 +4349,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 223, + "weight": 215, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4479,7 +4481,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 227, + "weight": 219, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4543,7 +4545,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 225, + "weight": 217, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -5031,7 +5033,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 226, + "weight": 218, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -5115,7 +5117,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 229, + "weight": 221, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5207,7 +5209,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 228, + "weight": 220, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5299,7 +5301,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 230, + "weight": 222, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -6012,7 +6014,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 306, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6079,7 +6081,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 302, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6150,7 +6152,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 303, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6213,7 +6215,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 304, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6292,7 +6294,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 305, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6357,7 +6359,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 307, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6438,7 +6440,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 257, + "weight": 665, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6517,7 +6519,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "type": "integer", "format": "int32", @@ -6552,7 +6554,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 249, + "weight": 657, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6711,7 +6713,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 250, + "weight": 658, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6814,7 +6816,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 253, + "weight": 661, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6965,7 +6967,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 251, + "weight": 659, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -7075,7 +7077,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 255, + "weight": 663, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7176,7 +7178,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 260, + "weight": 668, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7299,7 +7301,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 259, + "weight": 667, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7420,7 +7422,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 415, + "weight": 827, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -7487,7 +7489,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 411, + "weight": 823, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -7558,7 +7560,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 412, + "weight": 824, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -7621,7 +7623,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 413, + "weight": 825, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -7700,7 +7702,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 414, + "weight": 826, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -7765,7 +7767,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 416, + "weight": 828, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -7845,7 +7847,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 407, + "weight": 819, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -7955,7 +7957,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 399, + "weight": 811, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -8130,7 +8132,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 400, + "weight": 812, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -8229,7 +8231,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 403, + "weight": 815, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -8370,7 +8372,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 401, + "weight": 813, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -8474,7 +8476,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 405, + "weight": 817, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -8570,7 +8572,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 410, + "weight": 822, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -8687,7 +8689,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 409, + "weight": 821, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -8802,7 +8804,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 484, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -8885,7 +8887,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 482, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -9004,7 +9006,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 483, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -9076,7 +9078,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 150, + "weight": 140, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -9151,7 +9153,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 149, + "weight": 139, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -9650,7 +9652,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 197, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -9735,7 +9737,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 201, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -9806,7 +9808,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 594, + "weight": 589, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -9899,7 +9901,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 808, + "weight": 1077, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -9990,7 +9992,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 593, + "weight": 588, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -10061,7 +10063,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 595, + "weight": 590, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -10152,7 +10154,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 596, + "weight": 591, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -10223,7 +10225,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 598, + "weight": 593, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -10303,7 +10305,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 597, + "weight": 592, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -10511,7 +10513,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 599, + "weight": 594, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -10591,7 +10593,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 379, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -10661,7 +10663,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 375, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -10735,7 +10737,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 376, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -10801,7 +10803,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 377, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -10883,7 +10885,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 378, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -10951,7 +10953,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 380, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -11035,7 +11037,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 371, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -11113,7 +11115,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "type": "integer", "format": "int32", @@ -11148,7 +11150,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 363, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -11302,7 +11304,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 364, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -11404,7 +11406,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 367, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -11550,7 +11552,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 365, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -11659,7 +11661,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 369, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -11759,7 +11761,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 374, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -11881,7 +11883,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 373, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -12001,7 +12003,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 570, + "weight": 565, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -12086,7 +12088,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 568, + "weight": 563, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -12177,7 +12179,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 569, + "weight": 564, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -12240,7 +12242,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 572, + "weight": 567, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -12316,7 +12318,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 571, + "weight": 566, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -12379,7 +12381,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 577, + "weight": 572, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -12472,7 +12474,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 575, + "weight": 570, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -12589,7 +12591,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 576, + "weight": 571, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -12660,7 +12662,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 578, + "weight": 573, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -12747,7 +12749,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 809, + "weight": 1078, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -12820,7 +12822,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 580, + "weight": 575, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -12916,7 +12918,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 573, + "weight": 568, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -12979,7 +12981,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 574, + "weight": 569, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -13060,7 +13062,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 450, + "weight": 862, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -13127,7 +13129,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 446, + "weight": 858, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -13198,7 +13200,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 447, + "weight": 859, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -13261,7 +13263,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 448, + "weight": 860, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -13340,7 +13342,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 449, + "weight": 861, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -13405,7 +13407,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 451, + "weight": 863, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -13486,7 +13488,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 439, + "weight": 851, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -13596,7 +13598,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 435, + "weight": 847, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -13744,7 +13746,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 438, + "weight": 850, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -13843,7 +13845,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 437, + "weight": 849, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -13984,7 +13986,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 436, + "weight": 848, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -14088,7 +14090,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 440, + "weight": 852, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -14878,6 +14880,11 @@ "description": "API mode when event triggered.", "x-example": "admin" }, + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" + }, "ip": { "type": "string", "description": "IP session in use when the session was created.", @@ -14965,6 +14972,7 @@ "userEmail", "userName", "mode", + "userType", "ip", "time", "osCode", @@ -14988,6 +14996,7 @@ "userEmail": "john@appwrite.io", "userName": "John Doe", "mode": "admin", + "userType": "user", "ip": "127.0.0.1", "time": "2020-10-15T06:38:00.000+00:00", "osCode": "Mac", diff --git a/specs/latest/swagger2-latest-console.json b/specs/latest/swagger2-latest-console.json index 802af887..226bdadd 100644 --- a/specs/latest/swagger2-latest-console.json +++ b/specs/latest/swagger2-latest-console.json @@ -319,7 +319,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 794, + "weight": 1036, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -382,7 +382,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 792, + "weight": 1034, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -483,7 +483,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 793, + "weight": 1035, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -542,7 +542,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 795, + "weight": 1037, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -648,7 +648,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 796, + "weight": 1038, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -707,7 +707,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 798, + "weight": 1040, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -983,7 +983,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 797, + "weight": 1039, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -1118,7 +1118,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 780, + "weight": 1022, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1177,7 +1177,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 781, + "weight": 1023, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1232,7 +1232,8 @@ "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -1269,7 +1270,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 784, + "weight": 1026, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1327,7 +1328,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 783, + "weight": 1025, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1390,7 +1391,8 @@ "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -1424,7 +1426,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 782, + "weight": 1024, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1559,7 +1561,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 213, + "weight": 205, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1633,7 +1635,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 215, + "weight": 207, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1756,7 +1758,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 216, + "weight": 208, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1896,7 +1898,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 217, + "weight": 209, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -2019,7 +2021,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 221, + "weight": 213, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2155,7 +2157,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 222, + "weight": 214, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2294,7 +2296,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 214, + "weight": 206, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2394,7 +2396,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 220, + "weight": 212, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2494,7 +2496,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 218, + "weight": 210, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2594,7 +2596,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 219, + "weight": 211, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2849,7 +2851,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 787, + "weight": 1029, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -2912,7 +2914,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 785, + "weight": 1027, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -2961,7 +2963,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 786, + "weight": 1028, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -3020,7 +3022,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 788, + "weight": 1030, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -3109,7 +3111,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 791, + "weight": 1033, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3170,7 +3172,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 789, + "weight": 1031, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3263,7 +3265,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 790, + "weight": 1032, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -4048,7 +4050,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -4087,6 +4089,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -4992,7 +4995,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -5031,6 +5034,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -5583,7 +5587,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 806, + "weight": 1075, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5644,7 +5648,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 807, + "weight": 1076, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5705,7 +5709,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 224, + "weight": 216, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5831,7 +5835,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 223, + "weight": 215, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -5963,7 +5967,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 227, + "weight": 219, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -6027,7 +6031,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 225, + "weight": 217, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6515,7 +6519,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 226, + "weight": 218, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6599,7 +6603,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 229, + "weight": 221, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6691,7 +6695,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 228, + "weight": 220, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6783,7 +6787,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 230, + "weight": 222, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7496,7 +7500,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 774, + "weight": 1016, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7561,7 +7565,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 775, + "weight": 1017, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7652,7 +7656,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 773, + "weight": 1015, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7710,7 +7714,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 776, + "weight": 1018, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7771,7 +7775,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 769, + "weight": 1011, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7836,7 +7840,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 770, + "weight": 1012, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -7961,7 +7965,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 768, + "weight": 1010, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -8022,7 +8026,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 771, + "weight": 1013, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -8117,7 +8121,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 772, + "weight": 1014, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -8180,7 +8184,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 779, + "weight": 1021, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8283,7 +8287,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 778, + "weight": 1020, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8348,7 +8352,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 777, + "weight": 1019, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8411,7 +8415,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 550, + "weight": 545, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8480,7 +8484,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 640, + "weight": 876, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8539,7 +8543,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 637, + "weight": 873, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8598,7 +8602,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 635, + "weight": 871, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8664,7 +8668,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 636, + "weight": 872, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8723,7 +8727,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 638, + "weight": 874, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8784,7 +8788,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 639, + "weight": 875, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8843,7 +8847,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 634, + "weight": 870, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -8887,7 +8891,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 551, + "weight": 546, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -8960,7 +8964,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 641, + "weight": 877, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -9056,7 +9060,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 642, + "weight": 878, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -9151,7 +9155,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 643, + "weight": 879, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9238,7 +9242,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 549, + "weight": 544, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9287,7 +9291,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 238, + "weight": 646, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9403,7 +9407,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 234, + "weight": 642, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9523,7 +9527,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 306, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9590,7 +9594,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 302, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -9661,7 +9665,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 303, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -9724,7 +9728,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 304, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -9803,7 +9807,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 305, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -9868,7 +9872,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 307, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -9949,7 +9953,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 241, + "weight": 649, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -10051,7 +10055,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 235, + "weight": 643, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -10145,7 +10149,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 236, + "weight": 644, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10257,7 +10261,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 237, + "weight": 645, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10350,7 +10354,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 246, + "weight": 654, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10445,7 +10449,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 242, + "weight": 650, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10575,7 +10579,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 243, + "weight": 651, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -10648,7 +10652,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 244, + "weight": 652, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -10727,6 +10731,12 @@ "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false } } } @@ -10753,7 +10763,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 245, + "weight": 653, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -10826,7 +10836,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 263, + "weight": 671, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -10896,10 +10906,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "consumes": [ "application\/json" ], @@ -10909,23 +10919,23 @@ "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "schema": { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/attributeBigint" } } }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 264, + "weight": 684, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10936,10 +10946,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [] @@ -10962,7 +10972,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": "", @@ -10986,11 +10996,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", "default": null, - "x-example": false, + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -11009,10 +11036,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "consumes": [ "application\/json" ], @@ -11022,9 +11049,141 @@ "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { + "description": "AttributeBigInt", + "schema": { + "$ref": "#\/definitions\/attributeBigint" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateBigIntAttribute", + "group": "attributes", + "weight": 685, + "cookies": false, + "type": "", + "demo": "databases\/update-big-int-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateBigIntColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "post": { + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Create a boolean attribute.\n", + "responses": { + "202": { "description": "AttributeBoolean", "schema": { "$ref": "#\/definitions\/attributeBoolean" @@ -11033,12 +11192,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "createBooleanAttribute", "group": "attributes", - "weight": 265, + "weight": 672, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/create-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11049,10 +11208,123 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.createBooleanColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": false, + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "patch": { + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "responses": { + "200": { + "description": "AttributeBoolean", + "schema": { + "$ref": "#\/definitions\/attributeBoolean" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateBooleanAttribute", + "group": "attributes", + "weight": 673, + "cookies": false, + "type": "", + "demo": "databases\/update-boolean-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateBooleanColumn" }, "auth": { "Project": [] @@ -11150,7 +11422,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 266, + "weight": 674, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -11218,7 +11490,8 @@ "type": "string", "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -11263,7 +11536,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 267, + "weight": 675, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -11332,7 +11605,8 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { @@ -11378,7 +11652,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 268, + "weight": 676, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -11492,7 +11766,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 269, + "weight": 677, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -11608,7 +11882,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 270, + "weight": 678, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -11731,7 +12005,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 271, + "weight": 679, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -11856,7 +12130,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 272, + "weight": 680, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -11986,7 +12260,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 273, + "weight": 681, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -12118,7 +12392,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 274, + "weight": 682, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12248,7 +12522,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 275, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12380,7 +12654,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 276, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12493,7 +12767,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 277, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12608,7 +12882,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 278, + "weight": 688, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -12715,7 +12989,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 279, + "weight": 689, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -12829,7 +13103,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 296, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -12944,7 +13218,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 297, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -13055,7 +13329,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 294, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13170,7 +13444,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 295, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13281,7 +13555,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 280, + "weight": 690, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13388,7 +13662,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 281, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13502,7 +13776,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 282, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13609,7 +13883,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 283, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -13723,7 +13997,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -13864,7 +14138,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -13975,7 +14249,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 696, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -14102,7 +14376,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 697, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -14225,7 +14499,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 292, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -14340,7 +14614,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 293, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -14451,7 +14725,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -14565,7 +14839,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -14681,7 +14955,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 290, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -14804,7 +15078,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 291, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -14952,7 +15226,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 261, + "weight": 669, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -15027,7 +15301,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 262, + "weight": 670, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -15107,7 +15381,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 257, + "weight": 665, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15186,7 +15460,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "type": "integer", "format": "int32", @@ -15221,7 +15495,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 249, + "weight": 657, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15412,7 +15686,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 254, + "weight": 662, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15547,7 +15821,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 252, + "weight": 660, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -15651,7 +15925,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 256, + "weight": 664, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -15749,7 +16023,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 250, + "weight": 658, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -15852,7 +16126,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 253, + "weight": 661, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -16003,7 +16277,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 251, + "weight": 659, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16113,7 +16387,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 255, + "weight": 663, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16212,7 +16486,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 258, + "weight": 666, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16305,7 +16579,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 260, + "weight": 668, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16428,7 +16702,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 259, + "weight": 667, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16549,7 +16823,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 301, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -16643,7 +16917,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 298, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -16783,7 +17057,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 299, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -16858,7 +17132,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 300, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -16938,7 +17212,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 247, + "weight": 655, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17021,7 +17295,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 248, + "weight": 656, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17112,7 +17386,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 239, + "weight": 647, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17217,7 +17491,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 240, + "weight": 648, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17330,7 +17604,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 385, + "weight": 797, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -17413,7 +17687,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 381, + "weight": 793, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -17497,7 +17771,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 415, + "weight": 827, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -17564,7 +17838,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 411, + "weight": 823, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -17635,7 +17909,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 412, + "weight": 824, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -17698,7 +17972,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 413, + "weight": 825, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -17777,7 +18051,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 414, + "weight": 826, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -17840,7 +18114,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 387, + "weight": 799, "cookies": false, "type": "", "demo": "documentsdb\/list-usage.md", @@ -17934,7 +18208,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 382, + "weight": 794, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -17995,7 +18269,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 383, + "weight": 795, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -18075,7 +18349,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 384, + "weight": 796, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -18136,7 +18410,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 392, + "weight": 804, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -18227,7 +18501,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 388, + "weight": 800, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -18353,7 +18627,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 389, + "weight": 801, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -18422,7 +18696,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 390, + "weight": 802, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -18496,6 +18770,12 @@ "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false } }, "required": [ @@ -18525,7 +18805,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 391, + "weight": 803, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -18594,7 +18874,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 407, + "weight": 819, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -18704,7 +18984,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 399, + "weight": 811, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -18879,7 +19159,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 404, + "weight": 816, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -19005,7 +19285,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 402, + "weight": 814, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -19104,7 +19384,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 406, + "weight": 818, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -19197,7 +19477,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 400, + "weight": 812, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -19296,7 +19576,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 403, + "weight": 815, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -19437,7 +19717,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 401, + "weight": 813, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -19541,7 +19821,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 405, + "weight": 817, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -19635,7 +19915,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 408, + "weight": 820, "cookies": false, "type": "", "demo": "documentsdb\/list-document-logs.md", @@ -19724,7 +20004,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 410, + "weight": 822, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -19841,7 +20121,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 409, + "weight": 821, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -19956,7 +20236,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 398, + "weight": 810, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -20046,7 +20326,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 395, + "weight": 807, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -20108,8 +20388,7 @@ "enum": [ "key", "fulltext", - "unique", - "spatial" + "unique" ], "x-enum-name": "DocumentsDBIndexType", "x-enum-keys": [] @@ -20182,7 +20461,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 396, + "weight": 808, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -20253,7 +20532,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 397, + "weight": 809, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -20329,7 +20608,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 393, + "weight": 805, "cookies": false, "type": "", "demo": "documentsdb\/list-collection-logs.md", @@ -20408,7 +20687,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 394, + "weight": 806, "cookies": false, "type": "", "demo": "documentsdb\/get-collection-usage.md", @@ -20495,7 +20774,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 386, + "weight": 798, "cookies": false, "type": "", "demo": "documentsdb\/get-usage.md", @@ -20600,7 +20879,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 649, + "weight": 885, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -20671,7 +20950,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 644, + "weight": 880, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -20746,7 +21025,7 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 647, + "weight": 883, "cookies": false, "type": "", "demo": "domains\/get-price.md", @@ -20831,7 +21110,7 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 694, + "weight": 930, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", @@ -20977,7 +21256,7 @@ "x-appwrite": { "method": "updatePurchase", "group": null, - "weight": 695, + "weight": 931, "cookies": false, "type": "", "demo": "domains\/update-purchase.md", @@ -21053,7 +21332,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 693, + "weight": 929, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -21163,7 +21442,7 @@ "x-appwrite": { "method": "createTransferIn", "group": null, - "weight": 654, + "weight": 890, "cookies": false, "type": "", "demo": "domains\/create-transfer-in.md", @@ -21260,7 +21539,7 @@ "x-appwrite": { "method": "updateTransferIn", "group": null, - "weight": 655, + "weight": 891, "cookies": false, "type": "", "demo": "domains\/update-transfer-in.md", @@ -21338,7 +21617,7 @@ "x-appwrite": { "method": "createTransferOut", "group": null, - "weight": 656, + "weight": 892, "cookies": false, "type": "", "demo": "domains\/create-transfer-out.md", @@ -21413,7 +21692,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 646, + "weight": 882, "cookies": false, "type": "", "demo": "domains\/get.md", @@ -21468,7 +21747,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 645, + "weight": 881, "cookies": false, "type": "", "demo": "domains\/delete.md", @@ -21528,7 +21807,7 @@ "x-appwrite": { "method": "updateAutoRenewal", "group": null, - "weight": 650, + "weight": 886, "cookies": false, "type": "", "demo": "domains\/update-auto-renewal.md", @@ -21606,7 +21885,7 @@ "x-appwrite": { "method": "updateNameservers", "group": null, - "weight": 651, + "weight": 887, "cookies": false, "type": "", "demo": "domains\/update-nameservers.md", @@ -21664,7 +21943,7 @@ "x-appwrite": { "method": "getPresetGoogleWorkspace", "group": null, - "weight": 682, + "weight": 918, "cookies": false, "type": "", "demo": "domains\/get-preset-google-workspace.md", @@ -21722,7 +22001,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 681, + "weight": 917, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -21780,7 +22059,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 692, + "weight": 928, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -21838,7 +22117,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 691, + "weight": 927, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -21896,7 +22175,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 684, + "weight": 920, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -21954,7 +22233,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 683, + "weight": 919, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -22012,7 +22291,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 690, + "weight": 926, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -22070,7 +22349,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 689, + "weight": 925, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -22128,7 +22407,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 688, + "weight": 924, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -22186,7 +22465,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 687, + "weight": 923, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -22244,7 +22523,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 686, + "weight": 922, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -22302,7 +22581,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 685, + "weight": 921, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -22360,7 +22639,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 680, + "weight": 916, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -22432,7 +22711,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 658, + "weight": 894, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -22531,7 +22810,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 659, + "weight": 895, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -22638,7 +22917,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 660, + "weight": 896, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -22737,7 +23016,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 661, + "weight": 897, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -22844,7 +23123,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 662, + "weight": 898, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -22943,7 +23222,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 663, + "weight": 899, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -23050,7 +23329,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 664, + "weight": 900, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -23149,7 +23428,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 665, + "weight": 901, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -23256,7 +23535,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 666, + "weight": 902, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -23355,7 +23634,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 667, + "weight": 903, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -23462,7 +23741,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 668, + "weight": 904, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -23561,7 +23840,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 669, + "weight": 905, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -23668,7 +23947,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 670, + "weight": 906, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -23775,7 +24054,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 671, + "weight": 907, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -23890,7 +24169,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 672, + "weight": 908, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -23989,7 +24268,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 673, + "weight": 909, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -24096,7 +24375,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 674, + "weight": 910, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -24219,7 +24498,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 675, + "weight": 911, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -24350,7 +24629,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 676, + "weight": 912, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -24448,7 +24727,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 677, + "weight": 913, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -24553,7 +24832,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 679, + "weight": 915, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -24616,7 +24895,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 678, + "weight": 914, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -24684,7 +24963,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 653, + "weight": 889, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -24760,7 +25039,7 @@ "x-appwrite": { "method": "getTransferStatus", "group": null, - "weight": 657, + "weight": 893, "cookies": false, "type": "", "demo": "domains\/get-transfer-status.md", @@ -24818,7 +25097,7 @@ "x-appwrite": { "method": "getZone", "group": null, - "weight": 648, + "weight": 884, "cookies": false, "type": "", "demo": "domains\/get-zone.md", @@ -24876,7 +25155,7 @@ "x-appwrite": { "method": "updateZone", "group": null, - "weight": 652, + "weight": 888, "cookies": false, "type": "", "demo": "domains\/update-zone.md", @@ -24952,7 +25231,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 468, + "weight": 463, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -25034,7 +25313,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 628, + "weight": 864, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -25134,6 +25413,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -25171,7 +25451,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -25300,6 +25581,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -25398,7 +25683,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 470, + "weight": 465, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -25448,7 +25733,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 471, + "weight": 466, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -25498,7 +25783,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 494, + "weight": 489, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -25581,6 +25866,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -25618,7 +25904,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -25705,7 +25992,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 493, + "weight": 488, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -25763,7 +26050,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 487, + "weight": 482, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -25833,7 +26120,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 466, + "weight": 461, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -25893,7 +26180,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 629, + "weight": 865, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -25995,6 +26282,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -26032,7 +26320,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -26161,6 +26450,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -26253,7 +26546,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 469, + "weight": 464, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -26315,7 +26608,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 474, + "weight": 469, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -26393,7 +26686,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 475, + "weight": 470, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -26483,7 +26776,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 472, + "weight": 467, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -26576,7 +26869,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 480, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -26662,7 +26955,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 477, + "weight": 472, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -26783,7 +27076,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 478, + "weight": 473, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -26880,7 +27173,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 473, + "weight": 468, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -26943,7 +27236,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 476, + "weight": 471, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -27011,7 +27304,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 479, + "weight": 474, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -27097,7 +27390,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 481, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -27165,7 +27458,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 484, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -27248,7 +27541,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 482, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -27367,7 +27660,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 483, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -27432,7 +27725,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 485, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -27500,7 +27793,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 486, + "weight": 481, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -27578,7 +27871,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 490, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -27638,7 +27931,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 630, + "weight": 866, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -27729,7 +28022,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 489, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -27797,7 +28090,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 491, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -27892,7 +28185,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 492, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -27962,7 +28255,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 150, + "weight": 140, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -28037,7 +28330,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 149, + "weight": 139, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -28110,7 +28403,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 495, + "weight": 490, "cookies": false, "type": "", "demo": "health\/get.md", @@ -28161,7 +28454,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 504, + "weight": 499, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -28212,7 +28505,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 498, + "weight": 493, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -28263,7 +28556,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 501, + "weight": 496, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -28323,7 +28616,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 762, + "weight": 1004, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -28394,7 +28687,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 497, + "weight": 492, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -28445,7 +28738,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 499, + "weight": 494, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -28483,7 +28776,7 @@ "tags": [ "health" ], - "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.", + "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.\n", "responses": { "200": { "description": "Health Queue", @@ -28496,7 +28789,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 505, + "weight": 500, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -28558,7 +28851,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 758, + "weight": 1000, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -28620,7 +28913,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 757, + "weight": 999, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -28682,7 +28975,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 509, + "weight": 504, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -28744,7 +29037,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 759, + "weight": 1001, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -28806,7 +29099,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 508, + "weight": 503, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -28868,7 +29161,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 510, + "weight": 505, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -28939,7 +29232,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 511, + "weight": 506, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -29001,7 +29294,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 518, + "weight": 513, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -29088,7 +29381,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 515, + "weight": 510, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -29150,7 +29443,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 507, + "weight": 502, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -29212,7 +29505,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 512, + "weight": 507, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -29274,7 +29567,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 513, + "weight": 508, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -29336,7 +29629,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 514, + "weight": 509, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -29398,7 +29691,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 760, + "weight": 1002, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -29460,7 +29753,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 516, + "weight": 511, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -29522,7 +29815,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 517, + "weight": 512, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -29584,7 +29877,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 761, + "weight": 1003, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -29646,7 +29939,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 506, + "weight": 501, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -29708,7 +30001,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 503, + "weight": 498, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -29759,7 +30052,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 502, + "weight": 497, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -29810,7 +30103,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 500, + "weight": 495, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -30285,7 +30578,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 205, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -30370,7 +30663,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 202, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -30490,7 +30783,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -30530,7 +30824,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 209, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -30652,7 +30946,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "attachments": { @@ -30697,7 +30992,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 204, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -30834,7 +31129,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -30896,7 +31192,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 211, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -31048,7 +31344,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -31110,7 +31407,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 203, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -31261,7 +31558,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -31300,7 +31598,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 210, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -31456,7 +31754,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -31489,7 +31788,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 208, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -31545,7 +31844,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 212, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -31606,7 +31905,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 206, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -31688,7 +31987,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 207, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -31770,7 +32069,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 176, + "weight": 168, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -31855,7 +32154,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 175, + "weight": 167, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -32044,7 +32343,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 189, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -32230,7 +32529,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 174, + "weight": 166, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -32388,7 +32687,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 188, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -32542,7 +32841,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 165, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -32674,7 +32973,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 179, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -32803,7 +33102,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 169, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -32908,7 +33207,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 183, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -33011,7 +33310,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 167, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -33130,7 +33429,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 181, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -33246,7 +33545,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 166, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -33365,7 +33664,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 180, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -33481,7 +33780,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 168, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -33731,7 +34030,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 182, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -33975,7 +34274,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 170, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -34081,7 +34380,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 184, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -34184,7 +34483,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 171, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -34290,7 +34589,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 185, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -34393,7 +34692,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 172, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -34499,7 +34798,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 186, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -34602,7 +34901,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 173, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -34708,7 +35007,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 187, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -34809,7 +35108,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 178, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -34865,7 +35164,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 190, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -34926,7 +35225,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 177, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -35008,7 +35307,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 199, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -35090,7 +35389,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 192, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -35173,7 +35472,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 191, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -35262,7 +35561,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 194, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -35323,7 +35622,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 195, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -35405,7 +35704,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 196, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -35466,7 +35765,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 193, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -35548,7 +35847,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 198, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -35639,7 +35938,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 197, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -35727,7 +36026,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 200, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -35791,7 +36090,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 201, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -35862,7 +36161,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 157, + "weight": 149, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -35945,7 +36244,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 151, + "weight": 141, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -36068,7 +36367,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 159, + "weight": 151, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -36186,7 +36485,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 156, + "weight": 146, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -36312,7 +36611,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 155, + "weight": 145, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -36403,7 +36702,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 152, + "weight": 142, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -36496,7 +36795,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 160, + "weight": 152, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -36556,6 +36855,199 @@ ] } }, + "\/migrations\/json\/exports": { + "post": { + "summary": "Export documents to JSON", + "operationId": "migrationsCreateJSONExport", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "migrations" + ], + "description": "Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.\n", + "responses": { + "202": { + "description": "Migration", + "schema": { + "$ref": "#\/definitions\/migration" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createJSONExport", + "group": null, + "weight": 148, + "cookies": false, + "type": "", + "demo": "migrations\/create-json-export.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "migrations.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-json-export.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.", + "default": null, + "x-example": "" + }, + "filename": { + "type": "string", + "description": "The name of the file to be created for the export, excluding the .json extension.", + "default": null, + "x-example": "" + }, + "columns": { + "type": "array", + "description": "List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "notify": { + "type": "boolean", + "description": "Set to true to receive an email when the export is complete. Default is true.", + "default": true, + "x-example": false + } + }, + "required": [ + "resourceId", + "filename" + ] + } + } + ] + } + }, + "\/migrations\/json\/imports": { + "post": { + "summary": "Import documents from a JSON", + "operationId": "migrationsCreateJSONImport", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "migrations" + ], + "description": "Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.\n", + "responses": { + "202": { + "description": "Migration", + "schema": { + "$ref": "#\/definitions\/migration" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createJSONImport", + "group": null, + "weight": 147, + "cookies": false, + "type": "", + "demo": "migrations\/create-json-import.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "migrations.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-json-import.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "bucketId": { + "type": "string", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "default": null, + "x-example": "" + }, + "fileId": { + "type": "string", + "description": "File ID.", + "default": null, + "x-example": "" + }, + "resourceId": { + "type": "string", + "description": "Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.", + "default": null, + "x-example": "" + }, + "internalFile": { + "type": "boolean", + "description": "Is the file stored in an internal bucket?", + "default": false, + "x-example": false + } + }, + "required": [ + "bucketId", + "fileId", + "resourceId" + ] + } + } + ] + } + }, "\/migrations\/nhost": { "post": { "summary": "Create NHost migration", @@ -36582,7 +37074,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 154, + "weight": 144, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -36718,7 +37210,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 162, + "weight": 154, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -36854,7 +37346,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 153, + "weight": 143, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -36984,7 +37476,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 161, + "weight": 153, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -37111,7 +37603,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 158, + "weight": 150, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -37170,7 +37662,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 163, + "weight": 155, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -37224,7 +37716,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 164, + "weight": 156, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -37283,7 +37775,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 715, + "weight": 951, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -37362,7 +37854,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 714, + "weight": 950, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -37504,7 +37996,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 748, + "weight": 984, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -37607,7 +38099,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 716, + "weight": 952, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -37642,6 +38134,398 @@ ] } }, + "\/organizations\/{organizationId}\/addons": { + "get": { + "summary": "List addons", + "operationId": "organizationsListAddons", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "organizations" + ], + "description": "List all billing addons for an organization.\n", + "responses": { + "200": { + "description": "Addons list", + "schema": { + "$ref": "#\/definitions\/addonList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listAddons", + "group": null, + "weight": 992, + "cookies": false, + "type": "", + "demo": "organizations\/list-addons.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/list-addons.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/organizations\/{organizationId}\/addons\/baa": { + "post": { + "summary": "Create BAA addon", + "operationId": "organizationsCreateBaaAddon", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "organizations" + ], + "description": "Create the BAA billing addon for an organization.\n", + "responses": { + "201": { + "description": "Addon", + "schema": { + "$ref": "#\/definitions\/addon" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBaaAddon", + "group": null, + "weight": 995, + "cookies": false, + "type": "", + "demo": "organizations\/create-baa-addon.md", + "rate-limit": 10, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/create-baa-addon.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/organizations\/{organizationId}\/addons\/{addonId}": { + "get": { + "summary": "Get addon", + "operationId": "organizationsGetAddon", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "organizations" + ], + "description": "Get the details of a billing addon for an organization.\n", + "responses": { + "200": { + "description": "Addon", + "schema": { + "$ref": "#\/definitions\/addon" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getAddon", + "group": null, + "weight": 993, + "cookies": false, + "type": "", + "demo": "organizations\/get-addon.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-addon.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "addonId", + "description": "Addon ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete addon", + "operationId": "organizationsDeleteAddon", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "organizations" + ], + "description": "Delete a billing addon for an organization.\n", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteAddon", + "group": null, + "weight": 996, + "cookies": false, + "type": "", + "demo": "organizations\/delete-addon.md", + "rate-limit": 10, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/delete-addon.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "addonId", + "description": "Addon ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/organizations\/{organizationId}\/addons\/{addonId}\/confirmations": { + "post": { + "summary": "Confirm addon payment after 3DS authentication", + "operationId": "organizationsConfirmAddonPayment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "organizations" + ], + "description": "Confirm payment for a billing addon for an organization.\n", + "responses": { + "200": { + "description": "Addon", + "schema": { + "$ref": "#\/definitions\/addon" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "confirmAddonPayment", + "group": null, + "weight": 997, + "cookies": false, + "type": "", + "demo": "organizations\/confirm-addon-payment.md", + "rate-limit": 10, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/confirm-addon-payment.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "addonId", + "description": "Addon ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/organizations\/{organizationId}\/addons\/{addon}\/price": { + "get": { + "summary": "Get addon price", + "operationId": "organizationsGetAddonPrice", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "organizations" + ], + "description": "Get the price details for a billing addon for an organization.\n", + "responses": { + "200": { + "description": "AddonPrice", + "schema": { + "$ref": "#\/definitions\/addonPrice" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getAddonPrice", + "group": null, + "weight": 994, + "cookies": false, + "type": "", + "demo": "organizations\/get-addon-price.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/get-addon-price.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "addon", + "description": "Addon key identifier (e.g. baa).", + "required": true, + "type": "string", + "x-example": "baa", + "enum": [ + "baa" + ], + "x-enum-name": null, + "x-enum-keys": [], + "in": "path" + } + ] + } + }, "\/organizations\/{organizationId}\/aggregations": { "get": { "summary": "List aggregations", @@ -37666,7 +38550,7 @@ "x-appwrite": { "method": "listAggregations", "group": null, - "weight": 731, + "weight": 967, "cookies": false, "type": "", "demo": "organizations\/list-aggregations.md", @@ -37737,7 +38621,7 @@ "x-appwrite": { "method": "getAggregation", "group": null, - "weight": 732, + "weight": 968, "cookies": false, "type": "", "demo": "organizations\/get-aggregation.md", @@ -37825,7 +38709,7 @@ "x-appwrite": { "method": "setBillingAddress", "group": null, - "weight": 724, + "weight": 960, "cookies": false, "type": "", "demo": "organizations\/set-billing-address.md", @@ -37899,7 +38783,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 725, + "weight": 961, "cookies": false, "type": "", "demo": "organizations\/delete-billing-address.md", @@ -37958,7 +38842,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 723, + "weight": 959, "cookies": false, "type": "", "demo": "organizations\/get-billing-address.md", @@ -38027,7 +38911,7 @@ "x-appwrite": { "method": "setBillingEmail", "group": null, - "weight": 743, + "weight": 979, "cookies": false, "type": "", "demo": "organizations\/set-billing-email.md", @@ -38107,7 +38991,7 @@ "x-appwrite": { "method": "updateBudget", "group": null, - "weight": 720, + "weight": 956, "cookies": false, "type": "", "demo": "organizations\/update-budget.md", @@ -38197,7 +39081,7 @@ "x-appwrite": { "method": "listCredits", "group": null, - "weight": 735, + "weight": 971, "cookies": false, "type": "", "demo": "organizations\/list-credits.md", @@ -38268,7 +39152,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 736, + "weight": 972, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -38345,7 +39229,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 734, + "weight": 970, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -38404,7 +39288,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 733, + "weight": 969, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -38473,7 +39357,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 749, + "weight": 985, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -38534,7 +39418,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 747, + "weight": 983, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -38629,7 +39513,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 750, + "weight": 986, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -38727,7 +39611,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 738, + "weight": 974, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -38798,7 +39682,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 737, + "weight": 973, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -38865,7 +39749,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 741, + "weight": 977, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -38934,7 +39818,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 742, + "weight": 978, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -39021,7 +39905,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 739, + "weight": 975, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -39088,7 +39972,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 740, + "weight": 976, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -39155,7 +40039,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 753, + "weight": 989, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -39222,7 +40106,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 751, + "weight": 987, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -39273,16 +40157,14 @@ "items": { "type": "string", "enum": [ - "platforms.read", - "platforms.write", "projects.read", "projects.write", - "keys.read", - "keys.write", "devKeys.read", "devKeys.write", "domains.read", - "domains.write" + "domains.write", + "keys.read", + "keys.write" ], "x-enum-name": null, "x-enum-keys": [] @@ -39292,7 +40174,8 @@ "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -39329,7 +40212,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 755, + "weight": 991, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -39395,7 +40278,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 752, + "weight": 988, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -39454,16 +40337,14 @@ "items": { "type": "string", "enum": [ - "platforms.read", - "platforms.write", "projects.read", "projects.write", - "keys.read", - "keys.write", "devKeys.read", "devKeys.write", "domains.read", - "domains.write" + "domains.write", + "keys.read", + "keys.write" ], "x-enum-name": null, "x-enum-keys": [] @@ -39473,7 +40354,8 @@ "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -39507,7 +40389,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 754, + "weight": 990, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -39575,7 +40457,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 727, + "weight": 963, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -39652,7 +40534,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 729, + "weight": 965, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -39713,7 +40595,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 728, + "weight": 964, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -39790,7 +40672,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 730, + "weight": 966, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -39849,7 +40731,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 726, + "weight": 962, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -39916,7 +40798,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 717, + "weight": 953, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -39975,7 +40857,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 718, + "weight": 954, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -40098,7 +40980,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 719, + "weight": 955, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -40157,7 +41039,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 746, + "weight": 982, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -40216,7 +41098,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 745, + "weight": 981, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -40286,7 +41168,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 721, + "weight": 957, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -40363,7 +41245,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 722, + "weight": 958, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -40400,6 +41282,8 @@ "description": "Starting date for the usage", "required": false, "type": "string", + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00", "in": "query" }, { @@ -40407,6 +41291,8 @@ "description": "End date for the usage", "required": false, "type": "string", + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00", "in": "query" } ] @@ -40438,7 +41324,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 744, + "weight": 980, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -40491,93 +41377,226 @@ ] } }, - "\/project\/usage": { - "get": { - "summary": "Get project usage stats", - "operationId": "projectGetUsage", - "consumes": [], + "\/project\/auth\/canonical-emails": { + "patch": { + "summary": "Update project auth canonical emails", + "operationId": "projectUpdateCanonicalEmails", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", + "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", "responses": { "200": { - "description": "UsageProject", + "description": "Project", "schema": { - "$ref": "#\/definitions\/usageProject" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 627, + "method": "updateCanonicalEmails", + "group": "auth", + "weight": 1072, "cookies": false, "type": "", - "demo": "project\/get-usage.md", + "demo": "project\/update-canonical-emails.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", "auth": { "Project": [] } }, "security": [ { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to require canonical email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/auth\/disposable-emails": { + "patch": { + "summary": "Update project auth disposable emails", + "operationId": "projectUpdateDisposableEmails", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDisposableEmails", + "group": "auth", + "weight": 1073, + "cookies": false, + "type": "", + "demo": "project\/update-disposable-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { "Project": [] } + }, + "security": [ + { + "Project": [], + "Key": [] + } ], "parameters": [ { - "name": "startDate", - "description": "Starting date for the usage", - "required": true, - "type": "string", - "in": "query" - }, + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/auth\/free-emails": { + "patch": { + "summary": "Update project auth free emails", + "operationId": "projectUpdateFreeEmails", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateFreeEmails", + "group": "auth", + "weight": 1074, + "cookies": false, + "type": "", + "demo": "project\/update-free-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "endDate", - "description": "End date for the usage", - "required": true, - "type": "string", - "in": "query" - }, + "Project": [], + "Key": [] + } + ], + "parameters": [ { - "name": "period", - "description": "Period used", - "required": false, - "type": "string", - "x-example": "1h", - "enum": [ - "1h", - "1d" - ], - "x-enum-name": "ProjectUsageRange", - "x-enum-keys": [ - "One Hour", - "One Day" - ], - "default": "1d", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] } }, - "\/project\/variables": { + "\/project\/keys": { "get": { - "summary": "List project variables", - "operationId": "projectListVariables", + "summary": "List project keys", + "operationId": "projectListKeys", "consumes": [], "produces": [ "application\/json" @@ -40585,27 +41604,27 @@ "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Get a list of all API keys from the current project.", "responses": { "200": { - "description": "Variables List", + "description": "API Keys List", "schema": { - "$ref": "#\/definitions\/variableList" + "$ref": "#\/definitions\/keyList" } } }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 623, + "method": "listKeys", + "group": "keys", + "weight": 1055, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/list-keys.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "keys.read", "platforms": [ "console", "server" @@ -40625,7 +41644,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", + "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: expire, accessedAt, name, scopes", "required": false, "type": "array", "collectionFormat": "multi", @@ -40647,8 +41666,8 @@ ] }, "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", + "summary": "Create project key", + "operationId": "projectCreateKey", "consumes": [ "application\/json" ], @@ -40658,27 +41677,27 @@ "tags": [ "project" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", "responses": { "201": { - "description": "Variable", + "description": "Key", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/key" } } }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 622, + "method": "createKey", + "group": "keys", + "weight": 1054, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/create-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "keys.write", "platforms": [ "console", "server" @@ -40702,45 +41721,129 @@ "schema": { "type": "object", "properties": { - "variableId": { + "keyId": { "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Key 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": "" + "x-example": "" }, - "key": { + "name": { "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "Key name. Max length: 128 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", "default": null, - "x-example": "" + "x-example": null, + "x-nullable": true, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "default": true, - "x-example": false + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } }, "required": [ - "variableId", - "key", - "value" + "keyId", + "name", + "scopes" ] } } ] } }, - "\/project\/variables\/{variableId}": { + "\/project\/keys\/{keyId}": { "get": { - "summary": "Get project variable", - "operationId": "projectGetVariable", + "summary": "Get project key", + "operationId": "projectGetKey", "consumes": [], "produces": [ "application\/json" @@ -40748,27 +41851,27 @@ "tags": [ "project" ], - "description": "Get a variable by its unique ID. ", + "description": "Get a key by its unique ID. ", "responses": { "200": { - "description": "Variable", + "description": "Key", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/key" } } }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 624, + "method": "getKey", + "group": "keys", + "weight": 1056, "cookies": false, "type": "", - "demo": "project\/get-variable.md", + "demo": "project\/get-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "keys.read", "platforms": [ "console", "server" @@ -40787,18 +41890,18 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "keyId", + "description": "Key ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, "put": { - "summary": "Update project variable", - "operationId": "projectUpdateVariable", + "summary": "Update project key", + "operationId": "projectUpdateKey", "consumes": [ "application\/json" ], @@ -40808,27 +41911,27 @@ "tags": [ "project" ], - "description": "Update variable by its unique ID.", + "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.", "responses": { "200": { - "description": "Variable", + "description": "Key", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/key" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 626, + "method": "updateKey", + "group": "keys", + "weight": 1058, "cookies": false, "type": "", - "demo": "project\/update-variable.md", + "demo": "project\/update-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "keys.write", "platforms": [ "console", "server" @@ -40847,11 +41950,11 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "keyId", + "description": "Key ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -40860,35 +41963,120 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "Key name. Max length: 128 chars.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": null, + "x-nullable": true, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", "default": null, - "x-example": false, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } - } + }, + "required": [ + "name", + "scopes" + ] } } ] }, "delete": { - "summary": "Delete project variable", - "operationId": "projectDeleteVariable", + "summary": "Delete project key", + "operationId": "projectDeleteKey", "consumes": [ "application\/json" ], @@ -40896,7 +42084,7 @@ "tags": [ "project" ], - "description": "Delete a variable by its unique ID. ", + "description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.", "responses": { "204": { "description": "No content" @@ -40904,16 +42092,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 625, + "method": "deleteKey", + "group": "keys", + "weight": 1057, "cookies": false, "type": "", - "demo": "project\/delete-variable.md", + "demo": "project\/delete-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "keys.write", "platforms": [ "console", "server" @@ -40932,50 +42120,126 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", + "name": "keyId", + "description": "Key ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/projects": { + "\/project\/labels": { + "put": { + "summary": "Update project labels", + "operationId": "projectUpdateLabels", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the project labels. Labels can be used to easily filter projects in an organization.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateLabels", + "group": null, + "weight": 1048, + "cookies": false, + "type": "", + "demo": "project\/update-labels.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "labels": { + "type": "array", + "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + } + }, + "required": [ + "labels" + ] + } + } + ] + } + }, + "\/project\/platforms": { "get": { - "summary": "List projects", - "operationId": "projectsList", + "summary": "List project platforms", + "operationId": "projectListPlatforms", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Get a list of all projects. You can use the query params to filter your results. ", + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", "responses": { "200": { - "description": "Projects List", + "description": "Platforms List", "schema": { - "$ref": "#\/definitions\/projectList" + "$ref": "#\/definitions\/platformList" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "projects", - "weight": 804, + "method": "listPlatforms", + "group": "platforms", + "weight": 1071, "cookies": false, "type": "", - "demo": "projects\/list.md", + "demo": "project\/list-platforms.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "platforms.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -40985,13 +42249,14 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, teamId, labels, search", + "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: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", "required": false, "type": "array", "collectionFormat": "multi", @@ -41001,15 +42266,6 @@ "default": [], "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -41020,10 +42276,12 @@ "in": "query" } ] - }, + } + }, + "\/project\/platforms\/android": { "post": { - "summary": "Create project", - "operationId": "projectsCreate", + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", "consumes": [ "application\/json" ], @@ -41031,42 +42289,43 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Create a new project. You can create a maximum of 100 projects per account. ", + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", "responses": { "201": { - "description": "Project", + "description": "Platform Android", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformAndroid" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "projects", - "weight": 802, + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1067, "cookies": false, "type": "", - "demo": "projects\/create.md", + "demo": "project\/create-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -41076,167 +42335,126 @@ "schema": { "type": "object", "properties": { - "projectId": { + "platformId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": null + "x-example": "" }, "name": { "type": "string", - "description": "Project name. Max length: 128 chars.", + "description": "Platform name. Max length: 128 chars.", "default": null, "x-example": "" }, - "teamId": { + "applicationId": { "type": "string", - "description": "Team unique ID.", + "description": "Android application ID. Max length: 256 chars.", "default": null, - "x-example": "" - }, - "region": { - "type": "string", - "description": "Project Region.", - "default": "fra", - "x-example": "fra", - "enum": [ - "fra", - "nyc", - "syd", - "sfo", - "sgp", - "tor" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "default": "", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "default": "", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal Name. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal Country. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal State. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal City. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalAddress": { - "type": "string", - "description": "Project legal Address. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalTaxId": { - "type": "string", - "description": "Project legal Tax ID. Max length: 256 chars.", - "default": "", - "x-example": "" + "x-example": "" } }, "required": [ - "projectId", + "platformId", "name", - "teamId" + "applicationId" ] } } ] } }, - "\/projects\/{projectId}": { - "get": { - "summary": "Get project", - "operationId": "projectsGet", - "consumes": [], + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", "responses": { "200": { - "description": "Project", + "description": "Platform Android", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformAndroid" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "projects", - "weight": 57, + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1062, "cookies": false, "type": "", - "demo": "projects\/get.md", + "demo": "project\/update-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } } ] - }, - "patch": { - "summary": "Update project", - "operationId": "projectsUpdate", + } + }, + "\/project\/platforms\/apple": { + "post": { + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", "consumes": [ "application\/json" ], @@ -41244,187 +42462,172 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update a project by its unique ID.", + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Apple", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformApple" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "projects", - "weight": 803, + "method": "createApplePlatform", + "group": "platforms", + "weight": 1066, "cookies": false, "type": "", - "demo": "projects\/update.md", + "demo": "project\/create-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "platformId": { "type": "string", - "description": "Project name. Max length: 128 chars.", + "description": "Platform 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": "" - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "default": "", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "default": "", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal name. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal country. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal state. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal city. Max length: 256 chars.", - "default": "", - "x-example": "" + "x-example": "" }, - "legalAddress": { + "name": { "type": "string", - "description": "Project legal address. Max length: 256 chars.", - "default": "", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" }, - "legalTaxId": { + "bundleIdentifier": { "type": "string", - "description": "Project legal tax ID. Max length: 256 chars.", - "default": "", - "x-example": "" + "description": "Apple bundle identifier. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "name" + "platformId", + "name", + "bundleIdentifier" ] } } ] - }, - "delete": { - "summary": "Delete project", - "operationId": "projectsDelete", + } + }, + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "projects" + "project" ], - "description": "Delete a project by its unique ID.", + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Platform Apple", + "schema": { + "$ref": "#\/definitions\/platformApple" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "projects", - "weight": 73, + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1061, "cookies": false, "type": "", - "demo": "projects\/delete.md", + "demo": "project\/update-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } } ] } }, - "\/projects\/{projectId}\/api": { - "patch": { - "summary": "Update API status", - "operationId": "projectsUpdateApiStatus", + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", "consumes": [ "application\/json" ], @@ -41432,156 +42635,85 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Linux", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformLinux" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateApiStatus", - "group": "projects", - "weight": 60, + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1069, "cookies": false, "type": "", - "demo": "projects\/update-api-status.md", + "demo": "project\/create-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatus" - }, - "methods": [ - { - "name": "updateApiStatus", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "api", - "status" - ], - "required": [ - "projectId", - "api", - "status" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/project" - } - ], - "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", - "demo": "projects\/update-api-status.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatus" - } - }, - { - "name": "updateAPIStatus", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "api", - "status" - ], - "required": [ - "projectId", - "api", - "status" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/project" - } - ], - "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", - "demo": "projects\/update-api-status.md", - "public": true - } - ], + "public": true, "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "api": { + "platformId": { "type": "string", - "description": "API name.", + "description": "Platform 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": "rest", - "enum": [ - "rest", - "graphql", - "realtime" - ], - "x-enum-name": null, - "x-enum-keys": [] + "x-example": "" }, - "status": { - "type": "boolean", - "description": "API status.", + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "api", - "status" + "platformId", + "name", + "packageName" ] } } ] } }, - "\/projects\/{projectId}\/api\/all": { - "patch": { - "summary": "Update all API status", - "operationId": "projectsUpdateApiStatusAll", + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", "consumes": [ "application\/json" ], @@ -41589,111 +42721,52 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", "responses": { "200": { - "description": "Project", + "description": "Platform Linux", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformLinux" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateApiStatusAll", - "group": "projects", - "weight": 61, + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1064, "cookies": false, "type": "", - "demo": "projects\/update-api-status-all.md", + "demo": "project\/update-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status-all.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatusAll" - }, - "methods": [ - { - "name": "updateApiStatusAll", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "status" - ], - "required": [ - "projectId", - "status" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/project" - } - ], - "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", - "demo": "projects\/update-api-status-all.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "projects.updateAPIStatusAll" - } - }, - { - "name": "updateAPIStatusAll", - "namespace": "projects", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "projectId", - "status" - ], - "required": [ - "projectId", - "status" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/project" - } - ], - "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", - "demo": "projects\/update-api-status-all.md", - "public": true - } - ], + "public": true, "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -41702,25 +42775,32 @@ "schema": { "type": "object", "properties": { - "status": { - "type": "boolean", - "description": "API status.", + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "status" + "name", + "packageName" ] } } ] } }, - "\/projects\/{projectId}\/auth\/duration": { - "patch": { - "summary": "Update project authentication duration", - "operationId": "projectsUpdateAuthDuration", + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", "consumes": [ "application\/json" ], @@ -41728,79 +42808,84 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update how long sessions created within a project should stay active for.", + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Web", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformWeb" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthDuration", - "group": "auth", - "weight": 66, + "method": "createWebPlatform", + "group": "platforms", + "weight": 1065, "cookies": false, "type": "", - "demo": "projects\/update-auth-duration.md", + "demo": "project\/create-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "duration": { - "type": "integer", - "description": "Project session length in seconds. Max length: 31536000 seconds.", + "platformId": { + "type": "string", + "description": "Platform 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": 0, - "format": "int32" + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": "", + "x-example": null } }, "required": [ - "duration" + "platformId", + "name" ] } } ] } }, - "\/projects\/{projectId}\/auth\/limit": { - "patch": { - "summary": "Update project users limit", - "operationId": "projectsUpdateAuthLimit", + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", "consumes": [ "application\/json" ], @@ -41808,51 +42893,52 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the maximum number of users allowed in this project. Set to 0 for unlimited users. ", + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", "responses": { "200": { - "description": "Project", + "description": "Platform Web", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformWeb" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthLimit", - "group": "auth", - "weight": 65, + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1060, "cookies": false, "type": "", - "demo": "projects\/update-auth-limit.md", + "demo": "project\/update-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -41861,26 +42947,31 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "description": "Set the max number of users allowed in this project. Use 0 for unlimited.", + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": 0, - "format": "int32" + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": "", + "x-example": null } }, "required": [ - "limit" + "name" ] } } ] } }, - "\/projects\/{projectId}\/auth\/max-sessions": { - "patch": { - "summary": "Update project user sessions limit", - "operationId": "projectsUpdateAuthSessionsLimit", + "\/project\/platforms\/windows": { + "post": { + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", "consumes": [ "application\/json" ], @@ -41888,79 +42979,85 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.", + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Windows", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformWindows" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthSessionsLimit", - "group": "auth", - "weight": 71, + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1068, "cookies": false, "type": "", - "demo": "projects\/update-auth-sessions-limit.md", + "demo": "project\/create-windows-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "description": "Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10", + "platformId": { + "type": "string", + "description": "Platform 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": 1, - "format": "int32" + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "limit" + "platformId", + "name", + "packageIdentifierName" ] } } ] } }, - "\/projects\/{projectId}\/auth\/memberships-privacy": { - "patch": { - "summary": "Update project memberships privacy attributes", - "operationId": "projectsUpdateMembershipsPrivacy", + "\/project\/platforms\/windows\/{platformId}": { + "put": { + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", "consumes": [ "application\/json" ], @@ -41968,51 +43065,52 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status. ", + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", "responses": { "200": { - "description": "Project", + "description": "Platform Windows", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformWindows" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipsPrivacy", - "group": "auth", - "weight": 64, + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1063, "cookies": false, "type": "", - "demo": "projects\/update-memberships-privacy.md", + "demo": "project\/update-windows-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -42021,236 +43119,197 @@ "schema": { "type": "object", "properties": { - "userName": { - "type": "boolean", - "description": "Set to true to show userName to members of a team.", - "default": null, - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true to show email to members of a team.", + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" }, - "mfa": { - "type": "boolean", - "description": "Set to true to show mfa to members of a team.", + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", "default": null, - "x-example": false + "x-example": "" } }, "required": [ - "userName", - "userEmail", - "mfa" + "name", + "packageIdentifierName" ] } } ] } }, - "\/projects\/{projectId}\/auth\/mock-numbers": { - "patch": { - "summary": "Update the mock numbers for the project", - "operationId": "projectsUpdateMockNumbers", - "consumes": [ - "application\/json" - ], + "\/project\/platforms\/{platformId}": { + "get": { + "summary": "Get project platform", + "operationId": "projectGetPlatform", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ", + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", "responses": { "200": { - "description": "Project", + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", "schema": { - "$ref": "#\/definitions\/project" + "x-oneOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ] } } }, "deprecated": false, "x-appwrite": { - "method": "updateMockNumbers", - "group": "auth", - "weight": 72, + "method": "getPlatform", + "group": "platforms", + "weight": 1070, "cookies": false, "type": "", - "demo": "projects\/update-mock-numbers.md", + "demo": "project\/get-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "numbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "object" - } - } - }, - "required": [ - "numbers" - ] - } } ] - } - }, - "\/projects\/{projectId}\/auth\/password-dictionary": { - "patch": { - "summary": "Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password", - "operationId": "projectsUpdateAuthPasswordDictionary", + }, + "delete": { + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "projects" + "project" ], - "description": "Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords. ", + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", "responses": { - "200": { - "description": "Project", - "schema": { - "$ref": "#\/definitions\/project" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthPasswordDictionary", - "group": "auth", - "weight": 69, + "method": "deletePlatform", + "group": "platforms", + "weight": 1059, "cookies": false, "type": "", - "demo": "projects\/update-auth-password-dictionary.md", + "demo": "project\/delete-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to enable checking user's password against most commonly used passwords. Default is false.", - "default": null, - "x-example": false - } - }, - "required": [ - "enabled" - ] - } } ] } }, - "\/projects\/{projectId}\/auth\/password-history": { - "patch": { - "summary": "Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.", - "operationId": "projectsUpdateAuthPasswordHistory", - "consumes": [ - "application\/json" - ], + "\/project\/usage": { + "get": { + "summary": "Get project usage stats", + "operationId": "projectGetUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.", + "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", "responses": { "200": { - "description": "Project", + "description": "UsageProject", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/usageProject" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthPasswordHistory", - "group": "auth", - "weight": 68, + "method": "getUsage", + "group": null, + "weight": 641, "cookies": false, "type": "", - "demo": "projects\/update-auth-password-history.md", + "demo": "project\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "projects.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", "auth": { "Project": [] } @@ -42262,118 +43321,119 @@ ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "startDate", + "description": "Starting date for the usage", "required": true, "type": "string", - "x-example": "", - "in": "path" + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0", - "default": null, - "x-example": 0, - "format": "int32" - } - }, - "required": [ - "limit" - ] - } + "name": "endDate", + "description": "End date for the usage", + "required": true, + "type": "string", + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00", + "in": "query" + }, + { + "name": "period", + "description": "Period used", + "required": false, + "type": "string", + "x-example": "1h", + "enum": [ + "1h", + "1d" + ], + "x-enum-name": "ProjectUsageRange", + "x-enum-keys": [ + "One Hour", + "One Day" + ], + "default": "1d", + "in": "query" } ] } }, - "\/projects\/{projectId}\/auth\/personal-data": { - "patch": { - "summary": "Update personal data check", - "operationId": "projectsUpdatePersonalDataCheck", - "consumes": [ - "application\/json" - ], + "\/project\/variables": { + "get": { + "summary": "List project variables", + "operationId": "projectListVariables", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords. ", + "description": "Get a list of all project environment variables.", "responses": { "200": { - "description": "Project", + "description": "Variables List", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/variableList" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePersonalDataCheck", - "group": "auth", - "weight": 70, + "method": "listVariables", + "group": "variables", + "weight": 1050, "cookies": false, "type": "", - "demo": "projects\/update-personal-data-check.md", + "demo": "project\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to check a password for similarity with personal data. Default is false.", - "default": null, - "x-example": false - } - }, - "required": [ - "enabled" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/projects\/{projectId}\/auth\/session-alerts": { - "patch": { - "summary": "Update project sessions emails", - "operationId": "projectsUpdateSessionAlerts", + }, + "post": { + "summary": "Create project variable", + "operationId": "projectCreateVariable", "consumes": [ "application\/json" ], @@ -42381,157 +43441,148 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.", + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Variable", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionAlerts", - "group": "auth", - "weight": 63, + "method": "createVariable", + "group": "variables", + "weight": 1049, "cookies": false, "type": "", - "demo": "projects\/update-session-alerts.md", + "demo": "project\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "alerts": { - "type": "boolean", - "description": "Set to true to enable session emails.", + "variableId": { + "type": "string", + "description": "Variable 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": "unique()", + "x-example": "" + }, + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", "default": null, + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "default": true, "x-example": false } }, "required": [ - "alerts" + "key", + "value" ] } } ] } }, - "\/projects\/{projectId}\/auth\/session-invalidation": { - "patch": { - "summary": "Update invalidate session option of the project", - "operationId": "projectsUpdateSessionInvalidation", - "consumes": [ - "application\/json" - ], + "\/project\/variables\/{variableId}": { + "get": { + "summary": "Get project variable", + "operationId": "projectGetVariable", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", + "description": "Get a variable by its unique ID. ", "responses": { "200": { - "description": "Project", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionInvalidation", - "group": "auth", - "weight": 93, + "method": "getVariable", + "group": "variables", + "weight": 1051, "cookies": false, "type": "", - "demo": "projects\/update-session-invalidation.md", + "demo": "project\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "type": "string", - "x-example": "", + "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.", - "operationId": "projectsUpdateAuthStatus", + }, + "put": { + "summary": "Update project variable", + "operationId": "projectUpdateVariable", "consumes": [ "application\/json" ], @@ -42539,70 +43590,52 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. ", + "description": "Update variable by its unique ID.", "responses": { "200": { - "description": "Project", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthStatus", - "group": "auth", - "weight": 67, + "method": "updateVariable", + "group": "variables", + "weight": 1053, "cookies": false, "type": "", - "demo": "projects\/update-auth-status.md", + "demo": "project\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "method", - "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "name": "variableId", + "description": "Variable ID.", "required": true, "type": "string", - "x-example": "email-password", - "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" - ], - "x-enum-name": "AuthMethod", - "x-enum-keys": [], + "x-example": "", "in": "path" }, { @@ -42611,35 +43644,43 @@ "schema": { "type": "object", "properties": { - "status": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secret": { "type": "boolean", - "description": "Set the status of this auth method.", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "status" - ] + } } } ] - } - }, - "\/projects\/{projectId}\/console-access": { - "patch": { - "summary": "Record console access to a project", - "operationId": "projectsUpdateConsoleAccess", + }, + "delete": { + "summary": "Delete project variable", + "operationId": "projectDeleteVariable", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "projects" + "project" ], - "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", + "description": "Delete a variable by its unique ID. ", "responses": { "204": { "description": "No content" @@ -42647,47 +43688,48 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateConsoleAccess", - "group": null, - "weight": 799, + "method": "deleteVariable", + "group": "variables", + "weight": 1052, "cookies": false, "type": "", - "demo": "projects\/update-console-access.md", + "demo": "project\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "project.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project ID", + "name": "variableId", + "description": "Variable ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/projects\/{projectId}\/dev-keys": { + "\/projects": { "get": { - "summary": "List dev keys", - "operationId": "projectsListDevKeys", + "summary": "List projects", + "operationId": "projectsList", "consumes": [], "produces": [ "application\/json" @@ -42695,27 +43737,27 @@ "tags": [ "projects" ], - "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", + "description": "Get a list of all projects. You can use the query params to filter your results. ", "responses": { "200": { - "description": "Dev Keys List", + "description": "Projects List", "schema": { - "$ref": "#\/definitions\/devKeyList" + "$ref": "#\/definitions\/projectList" } } }, "deprecated": false, "x-appwrite": { - "method": "listDevKeys", - "group": "devKeys", - "weight": 455, + "method": "list", + "group": "projects", + "weight": 1046, "cookies": false, "type": "", - "demo": "projects\/list-dev-keys.md", + "demo": "projects\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "projects.read", "platforms": [ "console" ], @@ -42731,17 +43773,9 @@ } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: accessedAt, expire", + "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, teamId, labels, search", "required": false, "type": "array", "collectionFormat": "multi", @@ -42750,12 +43784,30 @@ }, "default": [], "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, "post": { - "summary": "Create dev key", - "operationId": "projectsCreateDevKey", + "summary": "Create project", + "operationId": "projectsCreate", "consumes": [ "application\/json" ], @@ -42765,32 +43817,33 @@ "tags": [ "projects" ], - "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", + "description": "Create a new project. You can create a maximum of 100 projects per account. ", "responses": { "201": { - "description": "DevKey", + "description": "Project", "schema": { - "$ref": "#\/definitions\/devKey" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "createDevKey", - "group": "devKeys", - "weight": 452, + "method": "create", + "group": "projects", + "weight": 1044, "cookies": false, "type": "", - "demo": "projects\/create-dev-key.md", + "demo": "projects\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } @@ -42801,46 +43854,116 @@ } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "projectId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": null + }, "name": { "type": "string", - "description": "Key name. Max length: 128 chars.", + "description": "Project name. Max length: 128 chars.", "default": null, "x-example": "" }, - "expire": { + "teamId": { "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "description": "Team unique ID.", "default": null, - "x-example": null + "x-example": "" + }, + "region": { + "type": "string", + "description": "Project Region.", + "default": "fra", + "x-example": "fra", + "enum": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "description": { + "type": "string", + "description": "Project description. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "logo": { + "type": "string", + "description": "Project logo.", + "default": "", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Project URL.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "legalName": { + "type": "string", + "description": "Project legal Name. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalCountry": { + "type": "string", + "description": "Project legal Country. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalState": { + "type": "string", + "description": "Project legal State. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalCity": { + "type": "string", + "description": "Project legal City. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalAddress": { + "type": "string", + "description": "Project legal Address. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalTaxId": { + "type": "string", + "description": "Project legal Tax ID. Max length: 256 chars.", + "default": "", + "x-example": "" } }, "required": [ + "projectId", "name", - "expire" + "teamId" ] } } ] } }, - "\/projects\/{projectId}\/dev-keys\/{keyId}": { + "\/projects\/{projectId}": { "get": { - "summary": "Get dev key", - "operationId": "projectsGetDevKey", + "summary": "Get project", + "operationId": "projectsGet", "consumes": [], "produces": [ "application\/json" @@ -42848,32 +43971,33 @@ "tags": [ "projects" ], - "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", + "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", "responses": { "200": { - "description": "DevKey", + "description": "Project", "schema": { - "$ref": "#\/definitions\/devKey" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getDevKey", - "group": "devKeys", - "weight": 454, + "method": "get", + "group": "projects", + "weight": 57, "cookies": false, "type": "", - "demo": "projects\/get-dev-key.md", + "demo": "projects\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "projects.read", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } @@ -42891,20 +44015,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" } ] }, - "put": { - "summary": "Update dev key", - "operationId": "projectsUpdateDevKey", + "patch": { + "summary": "Update project", + "operationId": "projectsUpdate", "consumes": [ "application\/json" ], @@ -42914,32 +44030,33 @@ "tags": [ "projects" ], - "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", + "description": "Update a project by its unique ID.", "responses": { "200": { - "description": "DevKey", + "description": "Project", "schema": { - "$ref": "#\/definitions\/devKey" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDevKey", - "group": "devKeys", - "weight": 453, + "method": "update", + "group": "projects", + "weight": 1045, "cookies": false, "type": "", - "demo": "projects\/update-dev-key.md", + "demo": "projects\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } @@ -42958,14 +44075,6 @@ "x-example": "", "in": "path" }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", @@ -42974,28 +44083,76 @@ "properties": { "name": { "type": "string", - "description": "Key name. Max length: 128 chars.", + "description": "Project name. Max length: 128 chars.", "default": null, "x-example": "" }, - "expire": { + "description": { "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", - "default": null, - "x-example": null + "description": "Project description. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "logo": { + "type": "string", + "description": "Project logo.", + "default": "", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Project URL.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "legalName": { + "type": "string", + "description": "Project legal name. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalCountry": { + "type": "string", + "description": "Project legal country. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalState": { + "type": "string", + "description": "Project legal state. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalCity": { + "type": "string", + "description": "Project legal city. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalAddress": { + "type": "string", + "description": "Project legal address. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalTaxId": { + "type": "string", + "description": "Project legal tax ID. Max length: 256 chars.", + "default": "", + "x-example": "" } }, "required": [ - "name", - "expire" + "name" ] } } ] }, "delete": { - "summary": "Delete dev key", - "operationId": "projectsDeleteDevKey", + "summary": "Delete project", + "operationId": "projectsDelete", "consumes": [ "application\/json" ], @@ -43003,7 +44160,7 @@ "tags": [ "projects" ], - "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", + "description": "Delete a project by its unique ID.", "responses": { "204": { "description": "No content" @@ -43011,21 +44168,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteDevKey", - "group": "devKeys", - "weight": 456, + "method": "delete", + "group": "projects", + "weight": 73, "cookies": false, "type": "", - "demo": "projects\/delete-dev-key.md", + "demo": "projects\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md", "auth": { "Project": [] } @@ -43043,22 +44201,14 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" } ] } }, - "\/projects\/{projectId}\/jwts": { - "post": { - "summary": "Create JWT", - "operationId": "projectsCreateJWT", + "\/projects\/{projectId}\/api": { + "patch": { + "summary": "Update API status", + "operationId": "projectsUpdateApiStatus", "consumes": [ "application\/json" ], @@ -43068,23 +44218,23 @@ "tags": [ "projects" ], - "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", + "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", "responses": { - "201": { - "description": "JWT", + "200": { + "description": "Project", "schema": { - "$ref": "#\/definitions\/jwt" + "$ref": "#\/definitions\/project" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createJWT", - "group": "auth", - "weight": 79, + "method": "updateApiStatus", + "group": "projects", + "weight": 60, "cookies": false, "type": "", - "demo": "projects\/create-jwt.md", + "demo": "projects\/update-api-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -43093,169 +44243,719 @@ "console" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatus" }, - { - "name": "payload", + "methods": [ + { + "name": "updateApiStatus", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "api", + "status" + ], + "required": [ + "projectId", + "api", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/project" + } + ], + "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", + "demo": "projects\/update-api-status.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatus" + } + }, + { + "name": "updateAPIStatus", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "api", + "status" + ], + "required": [ + "projectId", + "api", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/project" + } + ], + "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.", + "demo": "projects\/update-api-status.md", + "public": true + } + ], + "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": { + "api": { + "type": "string", + "description": "API name.", + "default": null, + "x-example": "rest", + "enum": [ + "rest", + "graphql", + "realtime" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "status": { + "type": "boolean", + "description": "API status.", + "default": null, + "x-example": false + } + }, + "required": [ + "api", + "status" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/api\/all": { + "patch": { + "summary": "Update all API status", + "operationId": "projectsUpdateApiStatusAll", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateApiStatusAll", + "group": "projects", + "weight": 61, + "cookies": false, + "type": "", + "demo": "projects\/update-api-status-all.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status-all.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatusAll" + }, + "methods": [ + { + "name": "updateApiStatusAll", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "status" + ], + "required": [ + "projectId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/project" + } + ], + "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", + "demo": "projects\/update-api-status-all.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "projects.updateAPIStatusAll" + } + }, + { + "name": "updateAPIStatusAll", + "namespace": "projects", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "projectId", + "status" + ], + "required": [ + "projectId", + "status" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/project" + } + ], + "description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.", + "demo": "projects\/update-api-status-all.md", + "public": true + } + ], + "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": { + "status": { + "type": "boolean", + "description": "API status.", + "default": null, + "x-example": false + } + }, + "required": [ + "status" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/auth\/duration": { + "patch": { + "summary": "Update project authentication duration", + "operationId": "projectsUpdateAuthDuration", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update how long sessions created within a project should stay active for.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthDuration", + "group": "auth", + "weight": 66, + "cookies": false, + "type": "", + "demo": "projects\/update-auth-duration.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md", + "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": { + "duration": { + "type": "integer", + "description": "Project session length in seconds. Max length: 31536000 seconds.", + "default": null, + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "duration" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/auth\/limit": { + "patch": { + "summary": "Update project users limit", + "operationId": "projectsUpdateAuthLimit", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update the maximum number of users allowed in this project. Set to 0 for unlimited users. ", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthLimit", + "group": "auth", + "weight": 65, + "cookies": false, + "type": "", + "demo": "projects\/update-auth-limit.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md", + "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": { + "limit": { + "type": "integer", + "description": "Set the max number of users allowed in this project. Use 0 for unlimited.", + "default": null, + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "limit" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/auth\/max-sessions": { + "patch": { + "summary": "Update project user sessions limit", + "operationId": "projectsUpdateAuthSessionsLimit", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthSessionsLimit", + "group": "auth", + "weight": 71, + "cookies": false, + "type": "", + "demo": "projects\/update-auth-sessions-limit.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md", + "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": { + "limit": { + "type": "integer", + "description": "Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10", + "default": null, + "x-example": 1, + "format": "int32" + } + }, + "required": [ + "limit" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/auth\/memberships-privacy": { + "patch": { + "summary": "Update project memberships privacy attributes", + "operationId": "projectsUpdateMembershipsPrivacy", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status. ", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateMembershipsPrivacy", + "group": "auth", + "weight": 64, + "cookies": false, + "type": "", + "demo": "projects\/update-memberships-privacy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md", + "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": { - "scopes": { + "userName": { + "type": "boolean", + "description": "Set to true to show userName to members of a team.", + "default": null, + "x-example": false + }, + "userEmail": { + "type": "boolean", + "description": "Set to true to show email to members of a team.", + "default": null, + "x-example": false + }, + "mfa": { + "type": "boolean", + "description": "Set to true to show mfa to members of a team.", + "default": null, + "x-example": false + } + }, + "required": [ + "userName", + "userEmail", + "mfa" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/auth\/mock-numbers": { + "patch": { + "summary": "Update the mock numbers for the project", + "operationId": "projectsUpdateMockNumbers", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateMockNumbers", + "group": "auth", + "weight": 72, + "cookies": false, + "type": "", + "demo": "projects\/update-mock-numbers.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", + "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": { + "numbers": { "type": "array", - "description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.", + "description": "An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.", "default": null, "x-example": null, "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "policies.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] + "type": "object" } - }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "default": 900, - "x-example": 0, - "format": "int32" } }, "required": [ - "scopes" + "numbers" ] } } ] } }, - "\/projects\/{projectId}\/keys": { - "get": { - "summary": "List keys", - "operationId": "projectsListKeys", - "consumes": [], + "\/projects\/{projectId}\/auth\/password-dictionary": { + "patch": { + "summary": "Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password", + "operationId": "projectsUpdateAuthPasswordDictionary", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "projects" ], - "description": "Get a list of all API keys from the current project. ", + "description": "Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords. ", "responses": { "200": { - "description": "API Keys List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/keyList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "listKeys", - "group": "keys", - "weight": 75, + "method": "updateAuthPasswordDictionary", + "group": "auth", + "weight": 69, "cookies": false, "type": "", - "demo": "projects\/list-keys.md", + "demo": "projects\/update-auth-password-dictionary.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-keys.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md", "auth": { "Project": [] } @@ -43275,31 +44975,110 @@ "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: expire, accessedAt, name, scopes", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to enable checking user's password against most commonly used passwords. Default is false.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/auth\/password-history": { + "patch": { + "summary": "Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.", + "operationId": "projectsUpdateAuthPasswordHistory", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthPasswordHistory", + "group": "auth", + "weight": 68, + "cookies": false, + "type": "", + "demo": "projects\/update-auth-password-history.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0", + "default": null, + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "limit" + ] + } } ] - }, - "post": { - "summary": "Create key", - "operationId": "projectsCreateKey", + } + }, + "\/projects\/{projectId}\/auth\/personal-data": { + "patch": { + "summary": "Update personal data check", + "operationId": "projectsUpdatePersonalDataCheck", "consumes": [ "application\/json" ], @@ -43309,33 +45088,33 @@ "tags": [ "projects" ], - "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "description": "Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords. ", "responses": { - "201": { - "description": "Key", + "200": { + "description": "Project", "schema": { - "$ref": "#\/definitions\/key" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "createKey", - "group": "keys", - "weight": 74, + "method": "updatePersonalDataCheck", + "group": "auth", + "weight": 70, "cookies": false, "type": "", - "demo": "projects\/create-key.md", + "demo": "projects\/update-personal-data-check.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md", "auth": { "Project": [] } @@ -43360,157 +45139,140 @@ "schema": { "type": "object", "properties": { - "keyId": { - "type": "string", - "description": "Key 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": "unique()", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Key name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "scopes": { - "type": "array", - "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "enabled": { + "type": "boolean", + "description": "Set whether or not to check a password for similarity with personal data. Default is false.", "default": null, - "x-example": null, - "x-nullable": true, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "policies.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - } - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/auth\/session-alerts": { + "patch": { + "summary": "Update project sessions emails", + "operationId": "projectsUpdateSessionAlerts", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSessionAlerts", + "group": "auth", + "weight": 63, + "cookies": false, + "type": "", + "demo": "projects\/update-session-alerts.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md", + "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": { + "alerts": { + "type": "boolean", + "description": "Set to true to enable session emails.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": false } }, "required": [ - "name", - "scopes" + "alerts" ] } } ] } }, - "\/projects\/{projectId}\/keys\/{keyId}": { - "get": { - "summary": "Get key", - "operationId": "projectsGetKey", - "consumes": [], + "\/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": "Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.", + "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.", "responses": { "200": { - "description": "Key", + "description": "Project", "schema": { - "$ref": "#\/definitions\/key" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getKey", - "group": "keys", - "weight": 76, + "method": "updateSessionInvalidation", + "group": "auth", + "weight": 83, "cookies": false, "type": "", - "demo": "projects\/get-key.md", + "demo": "projects\/update-session-invalidation.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md", "auth": { "Project": [] } @@ -43530,18 +45292,30 @@ "in": "path" }, { - "name": "keyId", - "description": "Key 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" + ] + } } ] - }, - "put": { - "summary": "Update key", - "operationId": "projectsUpdateKey", + } + }, + "\/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.", + "operationId": "projectsUpdateAuthStatus", "consumes": [ "application\/json" ], @@ -43551,33 +45325,33 @@ "tags": [ "projects" ], - "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key. ", + "description": "Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. ", "responses": { "200": { - "description": "Key", + "description": "Project", "schema": { - "$ref": "#\/definitions\/key" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "updateKey", - "group": "keys", - "weight": 77, + "method": "updateAuthStatus", + "group": "auth", + "weight": 67, "cookies": false, "type": "", - "demo": "projects\/update-key.md", + "demo": "projects\/update-auth-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", "auth": { "Project": [] } @@ -43597,11 +45371,22 @@ "in": "path" }, { - "name": "keyId", - "description": "Key unique ID.", + "name": "method", + "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", "required": true, "type": "string", - "x-example": "", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": "AuthMethod", + "x-enum-keys": [], "in": "path" }, { @@ -43610,123 +45395,35 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Key name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "scopes": { - "type": "array", - "description": "Key scopes list. Maximum of 100 events are allowed.", - "default": null, - "x-example": null, - "x-nullable": true, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "policies.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - } - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "status": { + "type": "boolean", + "description": "Set the status of this auth method.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": false } }, "required": [ - "name", - "scopes" + "status" ] } } ] - }, - "delete": { - "summary": "Delete key", - "operationId": "projectsDeleteKey", + } + }, + "\/projects\/{projectId}\/console-access": { + "patch": { + "summary": "Record console access to a project", + "operationId": "projectsUpdateConsoleAccess", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "projects" ], - "description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls. ", + "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", "responses": { "204": { "description": "No content" @@ -43734,22 +45431,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteKey", - "group": "keys", - "weight": 78, + "method": "updateConsoleAccess", + "group": null, + "weight": 1041, "cookies": false, "type": "", - "demo": "projects\/delete-key.md", + "demo": "projects\/update-console-access.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", "auth": { "Project": [] } @@ -43762,57 +45459,47 @@ "parameters": [ { "name": "projectId", - "description": "Project unique ID.", + "description": "Project ID", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" } ] } }, - "\/projects\/{projectId}\/labels": { - "put": { - "summary": "Update project labels", - "operationId": "projectsUpdateLabels", - "consumes": [ - "application\/json" - ], + "\/projects\/{projectId}\/dev-keys": { + "get": { + "summary": "List dev keys", + "operationId": "projectsListDevKeys", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "projects" ], - "description": "Update the project labels by its unique ID. Labels can be used to easily filter projects in an organization.", + "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", "responses": { "200": { - "description": "Project", + "description": "Dev Keys List", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/devKeyList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLabels", - "group": "projects", - "weight": 460, + "method": "listDevKeys", + "group": "devKeys", + "weight": 451, "cookies": false, "type": "", - "demo": "projects\/update-labels.md", + "demo": "projects\/list-dev-keys.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "devKeys.read", "platforms": [ "console" ], @@ -43837,33 +45524,22 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "labels": { - "type": "array", - "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - } - }, - "required": [ - "labels" - ] - } + "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: accessedAt, expire", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" } ] - } - }, - "\/projects\/{projectId}\/oauth2": { - "patch": { - "summary": "Update project OAuth2", - "operationId": "projectsUpdateOAuth2", + }, + "post": { + "summary": "Create dev key", + "operationId": "projectsCreateDevKey", "consumes": [ "application\/json" ], @@ -43873,33 +45549,32 @@ "tags": [ "projects" ], - "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", + "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "DevKey", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/devKey" } } }, "deprecated": false, "x-appwrite": { - "method": "updateOAuth2", - "group": "auth", - "weight": 62, + "method": "createDevKey", + "group": "devKeys", + "weight": 448, "cookies": false, "type": "", - "demo": "projects\/update-o-auth-2.md", + "demo": "projects\/create-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "devKeys.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", "auth": { "Project": [] } @@ -43924,89 +45599,33 @@ "schema": { "type": "object", "properties": { - "provider": { - "type": "string", - "description": "Provider Name", - "default": null, - "x-example": "amazon", - "enum": [ - "amazon", - "apple", - "auth0", - "authentik", - "autodesk", - "bitbucket", - "bitly", - "box", - "dailymotion", - "discord", - "disqus", - "dropbox", - "etsy", - "facebook", - "figma", - "github", - "gitlab", - "google", - "linkedin", - "microsoft", - "notion", - "oidc", - "okta", - "paypal", - "paypalSandbox", - "podio", - "salesforce", - "slack", - "spotify", - "stripe", - "tradeshift", - "tradeshiftBox", - "twitch", - "wordpress", - "yahoo", - "yammer", - "yandex", - "zoho", - "zoom" - ], - "x-enum-name": "OAuthProvider", - "x-enum-keys": [] - }, - "appId": { + "name": { "type": "string", - "description": "Provider app ID. Max length: 256 chars.", + "description": "Key name. Max length: 128 chars.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, - "secret": { + "expire": { "type": "string", - "description": "Provider secret key. Max length: 512 chars.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "enabled": { - "type": "boolean", - "description": "Provider status. Set to 'false' to disable new session creation.", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", "default": null, - "x-example": false, - "x-nullable": true + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" } }, "required": [ - "provider" + "name", + "expire" ] } } ] } }, - "\/projects\/{projectId}\/platforms": { + "\/projects\/{projectId}\/dev-keys\/{keyId}": { "get": { - "summary": "List platforms", - "operationId": "projectsListPlatforms", + "summary": "Get dev key", + "operationId": "projectsGetDevKey", "consumes": [], "produces": [ "application\/json" @@ -44014,33 +45633,32 @@ "tags": [ "projects" ], - "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations. ", + "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", "responses": { "200": { - "description": "Platforms List", + "description": "DevKey", "schema": { - "$ref": "#\/definitions\/platformList" + "$ref": "#\/definitions\/devKey" } } }, "deprecated": false, "x-appwrite": { - "method": "listPlatforms", - "group": "platforms", - "weight": 81, + "method": "getDevKey", + "group": "devKeys", + "weight": 450, "cookies": false, "type": "", - "demo": "projects\/list-platforms.md", + "demo": "projects\/get-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "devKeys.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-platforms.md", "auth": { "Project": [] } @@ -44060,19 +45678,18 @@ "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "keyId", + "description": "Key unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] }, - "post": { - "summary": "Create platform", - "operationId": "projectsCreatePlatform", + "put": { + "summary": "Update dev key", + "operationId": "projectsUpdateDevKey", "consumes": [ "application\/json" ], @@ -44082,33 +45699,32 @@ "tags": [ "projects" ], - "description": "Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", "responses": { - "201": { - "description": "Platform", + "200": { + "description": "DevKey", "schema": { - "$ref": "#\/definitions\/platform" + "$ref": "#\/definitions\/devKey" } } }, "deprecated": false, "x-appwrite": { - "method": "createPlatform", - "group": "platforms", - "weight": 80, + "method": "updateDevKey", + "group": "devKeys", + "weight": 449, "cookies": false, "type": "", - "demo": "projects\/create-platform.md", + "demo": "projects\/update-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "devKeys.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-platform.md", "auth": { "Project": [] } @@ -44127,109 +45743,75 @@ "x-example": "", "in": "path" }, + { + "name": "keyId", + "description": "Key unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.", - "default": null, - "x-example": "web", - "enum": [ - "web", - "flutter-web", - "flutter-ios", - "flutter-android", - "flutter-linux", - "flutter-macos", - "flutter-windows", - "apple-ios", - "apple-macos", - "apple-watchos", - "apple-tvos", - "android", - "unity", - "react-native-ios", - "react-native-android" - ], - "x-enum-name": "PlatformType", - "x-enum-keys": [] - }, "name": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "Key name. Max length: 128 chars.", "default": null, "x-example": "" }, - "key": { - "type": "string", - "description": "Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "store": { - "type": "string", - "description": "App store or Google Play store ID. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "hostname": { + "expire": { "type": "string", - "description": "Platform client hostname. Max length: 256 chars.", - "default": "", - "x-example": null + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" } }, "required": [ - "type", - "name" + "name", + "expire" ] } } ] - } - }, - "\/projects\/{projectId}\/platforms\/{platformId}": { - "get": { - "summary": "Get platform", - "operationId": "projectsGetPlatform", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete dev key", + "operationId": "projectsDeleteDevKey", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "projects" ], - "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations. ", + "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", "responses": { - "200": { - "description": "Platform", - "schema": { - "$ref": "#\/definitions\/platform" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getPlatform", - "group": "platforms", - "weight": 82, + "method": "deleteDevKey", + "group": "devKeys", + "weight": 452, "cookies": false, "type": "", - "demo": "projects\/get-platform.md", + "demo": "projects\/delete-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "devKeys.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-platform.md", "auth": { "Project": [] } @@ -44249,18 +45831,20 @@ "in": "path" }, { - "name": "platformId", - "description": "Platform unique ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] - }, - "put": { - "summary": "Update platform", - "operationId": "projectsUpdatePlatform", + } + }, + "\/projects\/{projectId}\/jwts": { + "post": { + "summary": "Create JWT", + "operationId": "projectsCreateJWT", "consumes": [ "application\/json" ], @@ -44270,33 +45854,33 @@ "tags": [ "projects" ], - "description": "Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname. ", + "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", "responses": { - "200": { - "description": "Platform", + "201": { + "description": "JWT", "schema": { - "$ref": "#\/definitions\/platform" + "$ref": "#\/definitions\/jwt" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePlatform", - "group": "platforms", - "weight": 83, + "method": "createJWT", + "group": "auth", + "weight": 74, "cookies": false, "type": "", - "demo": "projects\/update-platform.md", + "demo": "projects\/create-jwt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-platform.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", "auth": { "Project": [] } @@ -44315,86 +45899,155 @@ "x-example": "", "in": "path" }, - { - "name": "platformId", - "description": "Platform unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", + "scopes": { + "type": "array", + "description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.", "default": null, - "x-example": "" - }, - "key": { - "type": "string", - "description": "Package name for android or bundle ID for iOS. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "store": { - "type": "string", - "description": "App store or Google Play store ID. Max length: 256 chars.", - "default": "", - "x-example": "" + "x-example": null, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } }, - "hostname": { - "type": "string", - "description": "Platform client URL. Max length: 256 chars.", - "default": "", - "x-example": null + "duration": { + "type": "integer", + "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "default": 900, + "x-example": 0, + "format": "int32" } }, "required": [ - "name" + "scopes" ] } } ] - }, - "delete": { - "summary": "Delete platform", - "operationId": "projectsDeletePlatform", + } + }, + "\/projects\/{projectId}\/oauth2": { + "patch": { + "summary": "Update project OAuth2", + "operationId": "projectsUpdateOAuth2", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "projects" ], - "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project. ", + "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } } }, "deprecated": false, "x-appwrite": { - "method": "deletePlatform", - "group": "platforms", - "weight": 84, + "method": "updateOAuth2", + "group": "auth", + "weight": 62, "cookies": false, "type": "", - "demo": "projects\/delete-platform.md", + "demo": "projects\/update-o-auth-2.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-platform.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", "auth": { "Project": [] } @@ -44414,12 +46067,87 @@ "in": "path" }, { - "name": "platformId", - "description": "Platform unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Provider Name", + "default": null, + "x-example": "amazon", + "enum": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "github", + "gitlab", + "google", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ], + "x-enum-name": "OAuthProvider", + "x-enum-keys": [] + }, + "appId": { + "type": "string", + "description": "Provider app ID. Max length: 256 chars.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "Provider secret key. Max length: 512 chars.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Provider status. Set to 'false' to disable new session creation.", + "default": null, + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "provider" + ] + } } ] } @@ -44448,7 +46176,7 @@ "x-appwrite": { "method": "listSchedules", "group": "schedules", - "weight": 464, + "weight": 459, "cookies": false, "type": "", "demo": "projects\/list-schedules.md", @@ -44528,7 +46256,7 @@ "x-appwrite": { "method": "createSchedule", "group": "schedules", - "weight": 805, + "weight": 1047, "cookies": false, "type": "", "demo": "projects\/create-schedule.md", @@ -44639,7 +46367,7 @@ "x-appwrite": { "method": "getSchedule", "group": "schedules", - "weight": 463, + "weight": 458, "cookies": false, "type": "", "demo": "projects\/get-schedule.md", @@ -44890,7 +46618,7 @@ "x-appwrite": { "method": "updateSmtp", "group": "templates", - "weight": 85, + "weight": 75, "cookies": false, "type": "", "demo": "projects\/update-smtp.md", @@ -45099,7 +46827,7 @@ "x-appwrite": { "method": "createSmtpTest", "group": "templates", - "weight": 86, + "weight": 76, "cookies": false, "type": "", "demo": "projects\/create-smtp-test.md", @@ -45318,7 +47046,7 @@ "x-appwrite": { "method": "updateStatus", "group": null, - "weight": 800, + "weight": 1042, "cookies": false, "type": "", "demo": "projects\/update-status.md", @@ -45402,7 +47130,7 @@ "x-appwrite": { "method": "updateTeam", "group": "projects", - "weight": 801, + "weight": 1043, "cookies": false, "type": "", "demo": "projects\/update-team.md", @@ -45479,7 +47207,7 @@ "x-appwrite": { "method": "getEmailTemplate", "group": "templates", - "weight": 88, + "weight": 78, "cookies": false, "type": "", "demo": "projects\/get-email-template.md", @@ -45700,7 +47428,7 @@ "x-appwrite": { "method": "updateEmailTemplate", "group": "templates", - "weight": 90, + "weight": 80, "cookies": false, "type": "", "demo": "projects\/update-email-template.md", @@ -45966,7 +47694,7 @@ "x-appwrite": { "method": "deleteEmailTemplate", "group": "templates", - "weight": 92, + "weight": 82, "cookies": false, "type": "", "demo": "projects\/delete-email-template.md", @@ -46187,7 +47915,7 @@ "x-appwrite": { "method": "getSmsTemplate", "group": "templates", - "weight": 87, + "weight": 77, "cookies": false, "type": "", "demo": "projects\/get-sms-template.md", @@ -46469,7 +48197,7 @@ "x-appwrite": { "method": "updateSmsTemplate", "group": "templates", - "weight": 89, + "weight": 79, "cookies": false, "type": "", "demo": "projects\/update-sms-template.md", @@ -46773,7 +48501,7 @@ "x-appwrite": { "method": "deleteSmsTemplate", "group": "templates", - "weight": 91, + "weight": 81, "cookies": false, "type": "", "demo": "projects\/delete-sms-template.md", @@ -47055,7 +48783,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 815, + "weight": 1084, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -47137,7 +48865,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 810, + "weight": 1079, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -47207,7 +48935,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 812, + "weight": 1081, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -47290,7 +49018,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 813, + "weight": 1082, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -47411,7 +49139,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 811, + "weight": 1080, "cookies": false, "type": "", "demo": "proxy\/create-site-rule.md", @@ -47492,7 +49220,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 814, + "weight": 1083, "cookies": false, "type": "", "demo": "proxy\/get-rule.md", @@ -47545,7 +49273,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 816, + "weight": 1085, "cookies": false, "type": "", "demo": "proxy\/delete-rule.md", @@ -47605,7 +49333,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 817, + "weight": 1086, "cookies": false, "type": "", "demo": "proxy\/update-rule-verification.md", @@ -47663,7 +49391,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 522, + "weight": 517, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -47745,7 +49473,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 631, + "weight": 867, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -47913,6 +49641,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -47950,7 +49679,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -48058,7 +49788,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 525, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -48108,7 +49838,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 548, + "weight": 543, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -48158,7 +49888,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 544, + "weight": 539, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -48284,7 +50014,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 545, + "weight": 540, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -48342,7 +50072,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 546, + "weight": 541, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -48412,7 +50142,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 521, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -48472,7 +50202,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 632, + "weight": 868, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -48642,6 +50372,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -48679,7 +50410,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -48780,7 +50512,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 524, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -48842,7 +50574,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 531, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -48920,7 +50652,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 530, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -49010,7 +50742,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 526, + "weight": 521, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -49112,7 +50844,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 534, + "weight": 529, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -49192,7 +50924,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 527, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -49313,7 +51045,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 528, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -49411,7 +51143,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 529, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -49474,7 +51206,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 532, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -49542,7 +51274,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 533, + "weight": 528, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -49628,7 +51360,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 535, + "weight": 530, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -49696,7 +51428,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 537, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -49777,7 +51509,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 536, + "weight": 531, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -49842,7 +51574,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 538, + "weight": 533, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -49910,7 +51642,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 547, + "weight": 542, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -49988,7 +51720,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 541, + "weight": 536, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -50048,7 +51780,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 633, + "weight": 869, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -50139,7 +51871,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 540, + "weight": 535, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -50207,7 +51939,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 542, + "weight": 537, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -50302,7 +52034,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 543, + "weight": 538, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -50370,7 +52102,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 589, + "weight": 584, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -50453,7 +52185,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 587, + "weight": 582, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -50600,7 +52332,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 588, + "weight": 583, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -50661,7 +52393,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 590, + "weight": 585, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -50804,7 +52536,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 591, + "weight": 586, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -50865,7 +52597,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 594, + "weight": 589, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -50958,7 +52690,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 808, + "weight": 1077, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -51049,7 +52781,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 593, + "weight": 588, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -51120,7 +52852,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 595, + "weight": 590, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -51211,7 +52943,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 596, + "weight": 591, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -51282,7 +53014,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 598, + "weight": 593, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -51362,7 +53094,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 597, + "weight": 592, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -51570,7 +53302,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 599, + "weight": 594, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -51650,7 +53382,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 601, + "weight": 596, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -51721,7 +53453,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 602, + "weight": 597, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -51800,7 +53532,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 312, + "weight": 722, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -51883,7 +53615,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 308, + "weight": 718, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -51967,7 +53699,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 379, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -52037,7 +53769,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 375, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -52111,7 +53843,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 376, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -52177,7 +53909,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 377, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -52259,7 +53991,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 378, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -52327,7 +54059,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 380, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -52411,7 +54143,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 314, + "weight": 724, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -52508,7 +54240,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 309, + "weight": 719, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -52569,7 +54301,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 310, + "weight": 720, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -52646,7 +54378,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 311, + "weight": 721, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -52707,7 +54439,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 319, + "weight": 729, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -52801,7 +54533,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 315, + "weight": 725, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -52930,7 +54662,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 316, + "weight": 726, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -53002,7 +54734,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 317, + "weight": 727, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -53053,141 +54785,371 @@ "schema": { "type": "object", "properties": { - "name": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "rowSecurity": { + "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 + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tablesDB" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTable", + "group": "tables", + "weight": 728, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "List columns in the table.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 734, + "cookies": false, + "type": "", + "demo": "tablesdb\/list-columns.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.read", + "collections.read" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "schema": { + "$ref": "#\/definitions\/columnBigint" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 747, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { "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).", + "description": "Column Key.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": null }, - "rowSecurity": { + "required": { "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, + "description": "Is column required?", + "default": null, "x-example": false }, - "enabled": { + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "default": true, + "description": "Is column an array?", + "default": false, "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", "consumes": [ "application\/json" ], - "produces": [], - "tags": [ - "tablesDB" - ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 318, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-table.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Columns List", + "description": "ColumnBigInt", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/columnBigint" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", + "method": "updateBigIntColumn", "group": "columns", - "weight": 324, + "weight": 748, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/update-big-int-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "tables.write", + "collections.write" ], "platforms": [ "console", @@ -53195,7 +55157,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", "auth": { "Project": [] } @@ -53224,25 +55186,61 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "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, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } @@ -53273,7 +55271,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 325, + "weight": 735, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -53385,7 +55383,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 326, + "weight": 736, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -53499,7 +55497,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 327, + "weight": 737, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -53566,7 +55564,8 @@ "type": "string", "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -53611,7 +55610,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 328, + "weight": 738, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -53679,7 +55678,8 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { @@ -53725,7 +55725,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 329, + "weight": 739, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -53838,7 +55838,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 330, + "weight": 740, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -53953,7 +55953,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 331, + "weight": 741, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -54075,7 +56075,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 332, + "weight": 742, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -54199,7 +56199,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 333, + "weight": 743, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -54328,7 +56328,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 334, + "weight": 744, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -54459,7 +56459,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 335, + "weight": 745, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -54588,7 +56588,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 336, + "weight": 746, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -54719,7 +56719,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 337, + "weight": 749, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -54831,7 +56831,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 338, + "weight": 750, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -54945,7 +56945,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 339, + "weight": 751, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -55051,7 +57051,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 340, + "weight": 752, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -55164,7 +57164,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 357, + "weight": 769, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -55282,7 +57282,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 358, + "weight": 770, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -55396,7 +57396,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 355, + "weight": 767, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -55514,7 +57514,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 356, + "weight": 768, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -55628,7 +57628,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 341, + "weight": 753, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -55734,7 +57734,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 342, + "weight": 754, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -55847,7 +57847,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 343, + "weight": 755, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -55953,7 +57953,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 344, + "weight": 756, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -56066,7 +58066,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 345, + "weight": 757, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -56206,7 +58206,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 347, + "weight": 759, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -56336,7 +58336,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 348, + "weight": 760, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -56462,7 +58462,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 353, + "weight": 765, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -56580,7 +58580,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 354, + "weight": 766, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -56694,7 +58694,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 349, + "weight": 761, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -56807,7 +58807,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 350, + "weight": 762, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -56922,7 +58922,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 351, + "weight": 763, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -57048,7 +59048,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 352, + "weight": 764, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -57199,7 +59199,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 322, + "weight": 732, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -57273,7 +59273,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 323, + "weight": 733, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -57354,7 +59354,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 346, + "weight": 758, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -57463,7 +59463,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 362, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -57556,7 +59556,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 359, + "weight": 771, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -57695,7 +59695,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 360, + "weight": 772, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -57769,7 +59769,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 361, + "weight": 773, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -57848,7 +59848,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 320, + "weight": 730, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -57930,7 +59930,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 371, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -58008,7 +60008,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "type": "integer", "format": "int32", @@ -58043,7 +60043,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 363, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -58225,7 +60225,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 368, + "weight": 780, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -58355,7 +60355,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 366, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -58458,7 +60458,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 370, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -58555,7 +60555,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 364, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -58657,7 +60657,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 367, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -58803,7 +60803,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 365, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -58912,7 +60912,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 369, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -59010,7 +61010,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 372, + "weight": 784, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -59102,7 +61102,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 374, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -59224,7 +61224,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 373, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -59344,7 +61344,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 321, + "weight": 731, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -59434,7 +61434,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 313, + "weight": 723, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -59542,7 +61542,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 570, + "weight": 565, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -59627,7 +61627,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 568, + "weight": 563, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -59718,7 +61718,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 569, + "weight": 564, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -59781,7 +61781,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 572, + "weight": 567, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -59857,7 +61857,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 571, + "weight": 566, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -59920,7 +61920,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 581, + "weight": 576, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -60000,7 +62000,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 577, + "weight": 572, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -60093,7 +62093,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 575, + "weight": 570, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -60210,7 +62210,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 576, + "weight": 571, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -60281,7 +62281,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 578, + "weight": 573, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -60368,7 +62368,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 809, + "weight": 1078, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -60441,7 +62441,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 580, + "weight": 575, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -60536,7 +62536,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 573, + "weight": 568, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -60598,7 +62598,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 574, + "weight": 569, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -60678,7 +62678,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 584, + "weight": 579, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -60767,7 +62767,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 582, + "weight": 577, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -60818,7 +62818,8 @@ "type": "string", "description": "Token expiry date", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -60851,7 +62852,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 583, + "weight": 578, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -60911,7 +62912,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 585, + "weight": 580, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -60954,7 +62955,8 @@ "type": "string", "description": "File token expiry date", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -60982,7 +62984,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 586, + "weight": 581, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -61042,7 +63044,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 104, + "weight": 94, "cookies": false, "type": "", "demo": "users\/list.md", @@ -61125,7 +63127,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 95, + "weight": 85, "cookies": false, "type": "", "demo": "users\/create.md", @@ -61226,7 +63228,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 98, + "weight": 88, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -61321,7 +63323,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 96, + "weight": 86, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -61414,7 +63416,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 112, + "weight": 102, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -61494,7 +63496,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 136, + "weight": 126, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -61557,7 +63559,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 97, + "weight": 87, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -61652,7 +63654,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 100, + "weight": 90, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -61747,7 +63749,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 101, + "weight": 91, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -61881,7 +63883,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 102, + "weight": 92, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -61997,7 +63999,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 99, + "weight": 89, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -62111,7 +64113,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 138, + "weight": 128, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -62182,7 +64184,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 105, + "weight": 95, "cookies": false, "type": "", "demo": "users\/get.md", @@ -62238,7 +64240,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 134, + "weight": 124, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -62301,7 +64303,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 119, + "weight": 109, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -62383,7 +64385,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 115, + "weight": 105, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -62464,7 +64466,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 137, + "weight": 127, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -62549,7 +64551,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 114, + "weight": 104, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -62631,7 +64633,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 110, + "weight": 100, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -62713,7 +64715,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 109, + "weight": 99, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -62806,7 +64808,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 124, + "weight": 114, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -62942,7 +64944,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 129, + "weight": 119, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -63074,7 +65076,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 125, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -63191,7 +65193,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 126, + "weight": 116, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -63308,7 +65310,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 128, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -63425,7 +65427,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 127, + "weight": 117, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -63544,7 +65546,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 117, + "weight": 107, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -63625,7 +65627,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 118, + "weight": 108, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -63706,7 +65708,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 120, + "weight": 110, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -63786,7 +65788,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 106, + "weight": 96, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -63847,7 +65849,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 122, + "weight": 112, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -63926,7 +65928,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 108, + "weight": 98, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -63996,7 +65998,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 130, + "weight": 120, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -64052,7 +66054,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 133, + "weight": 123, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -64110,7 +66112,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 132, + "weight": 122, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -64181,7 +66183,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 113, + "weight": 103, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -64260,7 +66262,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 111, + "weight": 101, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -64342,7 +66344,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 103, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -64454,7 +66456,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 107, + "weight": 97, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -64523,7 +66525,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 123, + "weight": 113, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -64614,7 +66616,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 135, + "weight": 125, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -64685,7 +66687,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 131, + "weight": 121, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -64771,7 +66773,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 121, + "weight": 111, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -64852,7 +66854,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 116, + "weight": 106, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -64923,9 +66925,16 @@ "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", "responses": { "200": { - "description": "DetectionFramework", + "description": "DetectionRuntime, or DetectionFramework", "schema": { - "$ref": "#\/definitions\/detectionFramework" + "x-oneOf": [ + { + "$ref": "#\/definitions\/detectionRuntime" + }, + { + "$ref": "#\/definitions\/detectionFramework" + } + ] } } }, @@ -64933,7 +66942,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 614, + "weight": 609, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -65019,9 +67028,16 @@ "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", "responses": { "200": { - "description": "Framework Provider Repositories List", + "description": "Runtime Provider Repositories List, or Framework Provider Repositories List", "schema": { - "$ref": "#\/definitions\/providerRepositoryFrameworkList" + "x-oneOf": [ + { + "$ref": "#\/definitions\/providerRepositoryRuntimeList" + }, + { + "$ref": "#\/definitions\/providerRepositoryFrameworkList" + } + ] } } }, @@ -65029,7 +67045,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 611, + "weight": 606, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -65123,7 +67139,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 609, + "weight": 604, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -65207,7 +67223,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 610, + "weight": 605, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -65274,7 +67290,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 612, + "weight": 607, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -65341,7 +67357,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 613, + "weight": 608, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -65425,7 +67441,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 819, + "weight": 1088, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -65510,7 +67526,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 607, + "weight": 602, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -65591,7 +67607,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 606, + "weight": 601, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -65645,7 +67661,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 608, + "weight": 603, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -65704,7 +67720,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 421, + "weight": 833, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -65787,7 +67803,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 417, + "weight": 829, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -65873,7 +67889,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 445, + "weight": 857, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -65985,7 +68001,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 450, + "weight": 862, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -66052,7 +68068,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 446, + "weight": 858, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -66123,7 +68139,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 447, + "weight": 859, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -66186,7 +68202,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 448, + "weight": 860, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -66265,7 +68281,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 449, + "weight": 861, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -66330,7 +68346,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 451, + "weight": 863, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -66411,7 +68427,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 423, + "weight": 835, "cookies": false, "type": "", "demo": "vectorsdb\/list-usage.md", @@ -66505,7 +68521,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 418, + "weight": 830, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -66566,7 +68582,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 419, + "weight": 831, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -66646,7 +68662,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 420, + "weight": 832, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -66707,7 +68723,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 428, + "weight": 840, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -66798,7 +68814,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 424, + "weight": 836, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -66913,7 +68929,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 425, + "weight": 837, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -66982,7 +68998,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 426, + "weight": 838, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -67092,7 +69108,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 427, + "weight": 839, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -67161,7 +69177,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 439, + "weight": 851, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -67271,7 +69287,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 435, + "weight": 847, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -67446,7 +69462,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 442, + "weight": 854, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -67572,7 +69588,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 441, + "weight": 853, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -67671,7 +69687,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 443, + "weight": 855, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -67764,7 +69780,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 438, + "weight": 850, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -67863,7 +69879,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 437, + "weight": 849, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -68004,7 +70020,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 436, + "weight": 848, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -68108,7 +70124,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 440, + "weight": 852, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -68202,7 +70218,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 444, + "weight": 856, "cookies": false, "type": "", "demo": "vectorsdb\/list-document-logs.md", @@ -68289,7 +70305,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 434, + "weight": 846, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -68379,7 +70395,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 431, + "weight": 843, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -68517,7 +70533,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 432, + "weight": 844, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -68588,7 +70604,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 433, + "weight": 845, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -68664,7 +70680,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 429, + "weight": 841, "cookies": false, "type": "", "demo": "vectorsdb\/list-collection-logs.md", @@ -68743,7 +70759,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 430, + "weight": 842, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection-usage.md", @@ -68830,7 +70846,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 422, + "weight": 834, "cookies": false, "type": "", "demo": "vectorsdb\/get-usage.md", @@ -68935,7 +70951,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 617, + "weight": 612, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -69008,7 +71024,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 616, + "weight": 611, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -69126,7 +71142,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 618, + "weight": 613, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -69186,7 +71202,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 620, + "weight": 615, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -69300,7 +71316,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 619, + "weight": 614, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -69362,7 +71378,7 @@ "x-appwrite": { "method": "updateSignature", "group": null, - "weight": 621, + "weight": 616, "cookies": false, "type": "", "demo": "webhooks\/update-signature.md", @@ -70408,35 +72424,6 @@ "devKeys": "" } }, - "platformList": { - "description": "Platforms List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of platforms that matched your query.", - "x-example": 5, - "format": "int32" - }, - "platforms": { - "type": "array", - "description": "List of platforms.", - "items": { - "type": "object", - "$ref": "#\/definitions\/platform" - }, - "x-example": "" - } - }, - "required": [ - "total", - "platforms" - ], - "example": { - "total": 5, - "platforms": "" - } - }, "countryList": { "description": "Countries List", "type": "object", @@ -71234,6 +73221,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -71357,6 +73347,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -71613,6 +73606,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for 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" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -73720,6 +75811,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -73843,6 +75937,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -74099,6 +76196,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -75874,6 +78069,11 @@ "description": "API mode when event triggered.", "x-example": "admin" }, + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" + }, "ip": { "type": "string", "description": "IP session in use when the session was created.", @@ -75961,6 +78161,7 @@ "userEmail", "userName", "mode", + "userType", "ip", "time", "osCode", @@ -75984,6 +78185,7 @@ "userEmail": "john@appwrite.io", "userName": "John Doe", "mode": "admin", + "userType": "user", "ip": "127.0.0.1", "time": "2020-10-15T06:38:00.000+00:00", "osCode": "Mac", @@ -79422,6 +81624,21 @@ "description": "Whether or not to check the user password for similarity with their personal data.", "x-example": true }, + "authDisposableEmails": { + "type": "boolean", + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true + }, + "authCanonicalEmails": { + "type": "boolean", + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true + }, + "authFreeEmails": { + "type": "boolean", + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true + }, "authMockNumbers": { "type": "array", "description": "An array of mock numbers and their corresponding verification codes (OTPs).", @@ -79473,8 +81690,23 @@ "type": "array", "description": "List of Platforms.", "items": { - "type": "object", - "$ref": "#\/definitions\/platform" + "x-anyOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ] }, "x-example": {} }, @@ -79727,6 +81959,9 @@ "authPasswordHistory", "authPasswordDictionary", "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", "authMockNumbers", "authSessionAlerts", "authMembershipsUserName", @@ -79797,6 +82032,9 @@ "authPasswordHistory": 5, "authPasswordDictionary": true, "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, "authMockNumbers": [ {} ], @@ -80181,8 +82419,186 @@ "enabled": "" } }, - "platform": { - "description": "Platform", + "platformWeb": { + "description": "Platform Web", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "hostname": { + "type": "string", + "description": "Web app hostname. Empty string for other platforms.", + "x-example": "app.example.com" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "hostname", + "key" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "hostname": "app.example.com" + } + }, + "platformApple": { + "description": "Platform Apple", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "bundleIdentifier" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "bundleIdentifier": "com.company.appname" + } + }, + "platformAndroid": { + "description": "Platform Android", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "applicationId": { + "type": "string", + "description": "Android application ID.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "applicationId" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "applicationId": "com.company.appname" + } + }, + "platformWindows": { + "description": "Platform Windows", "type": "object", "properties": { "$id": { @@ -80207,50 +82623,79 @@ }, "type": { "type": "string", - "description": "Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", "x-example": "web", "enum": [ - "web", - "flutter-web", - "flutter-ios", - "flutter-android", - "flutter-linux", - "flutter-macos", - "flutter-windows", - "apple-ios", - "apple-macos", - "apple-watchos", - "apple-tvos", + "windows", + "apple", "android", - "unity", - "react-native-ios", - "react-native-android" + "linux", + "web" ] }, - "key": { + "packageIdentifierName": { "type": "string", - "description": "Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.", + "description": "Windows package identifier name.", "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "packageIdentifierName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "packageIdentifierName": "com.company.appname" + } + }, + "platformLinux": { + "description": "Platform Linux", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" }, - "store": { + "$createdAt": { "type": "string", - "description": "App store or Google Play store ID.", - "x-example": "" + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "hostname": { + "$updatedAt": { "type": "string", - "description": "Web app hostname. Empty string for other platforms.", - "x-example": "app.example.com" + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "httpUser": { + "name": { "type": "string", - "description": "HTTP basic authentication username.", - "x-example": "username" + "description": "Platform name.", + "x-example": "My Web App" }, - "httpPass": { + "type": { "type": "string", - "description": "HTTP basic authentication password.", - "x-example": "password" + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "packageName": { + "type": "string", + "description": "Linux package name.", + "x-example": "com.company.appname" } }, "required": [ @@ -80259,11 +82704,7 @@ "$updatedAt", "name", "type", - "key", - "store", - "hostname", - "httpUser", - "httpPass" + "packageName" ], "example": { "$id": "5e5ea5c16897e", @@ -80271,11 +82712,51 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Web App", "type": "web", - "key": "com.company.appname", - "store": "", - "hostname": "app.example.com", - "httpUser": "username", - "httpPass": "password" + "packageName": "com.company.appname" + } + }, + "platformList": { + "description": "Platforms List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of platforms in the given project.", + "x-example": 5, + "format": "int32" + }, + "platforms": { + "type": "array", + "description": "List of platforms.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "platforms" + ], + "example": { + "total": 5, + "platforms": "" } }, "variable": { @@ -83653,6 +86134,11 @@ "type": "boolean", "description": "Whether the database adapter uses integer sequence IDs.", "x-example": true + }, + "_APP_CONSOLE_EMAIL_VERIFICATION": { + "type": "string", + "description": "Whether email verification for console users is required. Can be \"true\" or \"false\".", + "x-example": "true" } }, "required": [ @@ -83681,7 +86167,8 @@ "supportForAttributeResizing", "supportForSchemas", "maxIndexLength", - "supportForIntegerIds" + "supportForIntegerIds", + "_APP_CONSOLE_EMAIL_VERIFICATION" ], "example": { "_APP_DOMAIN_TARGET_CNAME": "appwrite.io", @@ -83709,7 +86196,8 @@ "supportForAttributeResizing": true, "supportForSchemas": true, "maxIndexLength": 768, - "supportForIntegerIds": true + "supportForIntegerIds": true, + "_APP_CONSOLE_EMAIL_VERIFICATION": "true" } }, "mfaChallenge": { @@ -85640,6 +88128,21 @@ "description": "Does plan support credit", "x-example": true }, + "supportsDisposableEmailValidation": { + "type": "boolean", + "description": "Does plan support blocking disposable email addresses.", + "x-example": true + }, + "supportsCanonicalEmailValidation": { + "type": "boolean", + "description": "Does plan support requiring canonical email addresses.", + "x-example": true + }, + "supportsFreeEmailValidation": { + "type": "boolean", + "description": "Does plan support blocking free email addresses.", + "x-example": true + }, "backupsEnabled": { "type": "boolean", "description": "Does plan support backup policies.", @@ -85650,6 +88153,15 @@ "description": "Whether usage addons are calculated per project.", "x-example": true }, + "supportedAddons": { + "type": "object", + "description": "Supported addons for this plan", + "x-example": null, + "items": { + "type": "object", + "$ref": "#\/definitions\/billingPlanSupportedAddons" + } + }, "backupPolicies": { "type": "integer", "description": "How many policies does plan support", @@ -85755,8 +88267,12 @@ "supportsMockNumbers", "supportsOrganizationRoles", "supportsCredits", + "supportsDisposableEmailValidation", + "supportsCanonicalEmailValidation", + "supportsFreeEmailValidation", "backupsEnabled", "usagePerProject", + "supportedAddons", "backupPolicies", "deploymentSize", "buildSize", @@ -85814,8 +88330,12 @@ "supportsMockNumbers": true, "supportsOrganizationRoles": true, "supportsCredits": true, + "supportsDisposableEmailValidation": true, + "supportsCanonicalEmailValidation": true, + "supportsFreeEmailValidation": true, "backupsEnabled": true, "usagePerProject": true, + "supportedAddons": null, "backupPolicies": true, "deploymentSize": 30, "buildSize": 2000, @@ -85951,6 +88471,23 @@ "dailyCredits": 5 } }, + "billingPlanSupportedAddons": { + "description": "BillingPlanSupportedAddons", + "type": "object", + "properties": { + "baa": { + "type": "boolean", + "description": "Whether the plan supports BAA (Business Associate Agreement) addon", + "x-example": true + } + }, + "required": [ + "baa" + ], + "example": { + "baa": true + } + }, "billingLimits": { "description": "BillingLimits", "type": "object", @@ -86046,21 +88583,21 @@ }, "reason": { "type": "string", - "description": "Reason for the block", - "x-example": "Payment overdue" + "description": "Reason for the block. Can be null if no reason was provided.", + "x-example": "Payment overdue", + "x-nullable": true }, "expiredAt": { "type": "string", - "description": "Block expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ "$createdAt", "resourceType", - "resourceId", - "reason", - "expiredAt" + "resourceId" ], "example": { "$createdAt": "2020-10-15T06:38:00.000+00:00", @@ -87034,19 +89571,26 @@ "type": "string", "description": "Invoice ID against which the payment needs to be validated.", "x-example": "" + }, + "addonId": { + "type": "string", + "description": "Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.", + "x-example": "" } }, "required": [ "message", "clientSecret", "organizationId", - "invoiceId" + "invoiceId", + "addonId" ], "example": { "message": "", "clientSecret": "", "organizationId": "", - "invoiceId": "" + "invoiceId": "", + "addonId": "" } }, "paymentMethod": { @@ -88806,6 +91350,165 @@ "available": true } }, + "addon": { + "description": "Addon", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Addon ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Addon creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Addon update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Addon permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "key": { + "type": "string", + "description": "Addon key", + "x-example": "baa" + }, + "resourceType": { + "type": "string", + "description": "Resource type (organization or project)", + "x-example": "organization" + }, + "resourceId": { + "type": "string", + "description": "Resource ID", + "x-example": "5e5ea5c16897e" + }, + "status": { + "type": "string", + "description": "Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).", + "x-example": "active" + }, + "currentValue": { + "type": "integer", + "description": "Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.", + "x-example": 1, + "format": "int32" + }, + "nextValue": { + "type": "integer", + "description": "Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.", + "x-example": null, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "key", + "resourceType", + "resourceId", + "status", + "currentValue" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "key": "baa", + "resourceType": "organization", + "resourceId": "5e5ea5c16897e", + "status": "active", + "currentValue": 1, + "nextValue": null + } + }, + "addonPrice": { + "description": "AddonPrice", + "type": "object", + "properties": { + "addonKey": { + "type": "string", + "description": "Addon key.", + "x-example": "baa" + }, + "name": { + "type": "string", + "description": "Addon display name.", + "x-example": "HIPAA BAA" + }, + "monthlyPrice": { + "type": "number", + "description": "Full monthly price of the addon.", + "x-example": 350, + "format": "double" + }, + "proratedAmount": { + "type": "number", + "description": "Calculated prorated amount for the current billing cycle.", + "x-example": 175.5, + "format": "double" + }, + "remainingDays": { + "type": "integer", + "description": "Days remaining in the current billing cycle.", + "x-example": 15, + "format": "int32" + }, + "totalCycleDays": { + "type": "integer", + "description": "Total days in the billing cycle.", + "x-example": 30, + "format": "int32" + }, + "currency": { + "type": "string", + "description": "Currency code.", + "x-example": "USD" + }, + "billingCycleEnd": { + "type": "string", + "description": "When the current billing cycle ends.", + "x-example": "2024-02-01T00:00:00.000+00:00" + } + }, + "required": [ + "addonKey", + "name", + "monthlyPrice", + "proratedAmount", + "remainingDays", + "totalCycleDays", + "currency", + "billingCycleEnd" + ], + "example": { + "addonKey": "baa", + "name": "HIPAA BAA", + "monthlyPrice": 350, + "proratedAmount": 175.5, + "remainingDays": 15, + "totalCycleDays": 30, + "currency": "USD", + "billingCycleEnd": "2024-02-01T00:00:00.000+00:00" + } + }, "domainTransferOut": { "description": "domainTransferOut", "type": "object", @@ -88865,6 +91568,35 @@ "timestamp": "2020-10-15T06:38:00.000+00:00" } }, + "addonList": { + "description": "Addons list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of addons that matched your query.", + "x-example": 5, + "format": "int32" + }, + "addons": { + "type": "array", + "description": "List of addons.", + "items": { + "type": "object", + "$ref": "#\/definitions\/addon" + }, + "x-example": "" + } + }, + "required": [ + "total", + "addons" + ], + "example": { + "total": 5, + "addons": "" + } + }, "activityEventList": { "description": "Activity event list", "type": "object", diff --git a/specs/latest/swagger2-latest-server.json b/specs/latest/swagger2-latest-server.json index 0f2a74e5..2a25d4eb 100644 --- a/specs/latest/swagger2-latest-server.json +++ b/specs/latest/swagger2-latest-server.json @@ -646,7 +646,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 213, + "weight": 205, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -722,7 +722,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 215, + "weight": 207, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -849,7 +849,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 216, + "weight": 208, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -993,7 +993,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 217, + "weight": 209, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1120,7 +1120,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 221, + "weight": 213, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1260,7 +1260,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 222, + "weight": 214, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1403,7 +1403,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 214, + "weight": 206, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1507,7 +1507,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 220, + "weight": 212, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1611,7 +1611,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 218, + "weight": 210, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1715,7 +1715,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 219, + "weight": 211, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3332,7 +3332,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -3371,6 +3371,7 @@ "tradeshiftBox", "twitch", "wordpress", + "x", "yahoo", "yammer", "yandex", @@ -3937,7 +3938,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 806, + "weight": 1075, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -3999,7 +4000,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 807, + "weight": 1076, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -4061,7 +4062,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 224, + "weight": 216, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4189,7 +4190,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 223, + "weight": 215, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4323,7 +4324,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 227, + "weight": 219, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4389,7 +4390,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 225, + "weight": 217, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4879,7 +4880,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 226, + "weight": 218, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4965,7 +4966,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 229, + "weight": 221, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5059,7 +5060,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 228, + "weight": 220, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5153,7 +5154,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 230, + "weight": 222, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5868,7 +5869,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 774, + "weight": 1016, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5934,7 +5935,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 775, + "weight": 1017, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -6026,7 +6027,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 773, + "weight": 1015, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -6085,7 +6086,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 776, + "weight": 1018, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6147,7 +6148,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 769, + "weight": 1011, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6213,7 +6214,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 770, + "weight": 1012, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6339,7 +6340,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 768, + "weight": 1010, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6401,7 +6402,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 771, + "weight": 1013, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6497,7 +6498,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 772, + "weight": 1014, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6561,7 +6562,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 779, + "weight": 1021, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6665,7 +6666,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 778, + "weight": 1020, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6731,7 +6732,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 777, + "weight": 1019, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6793,7 +6794,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 238, + "weight": 646, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6911,7 +6912,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 234, + "weight": 642, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -7033,7 +7034,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 306, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -7102,7 +7103,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 302, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7175,7 +7176,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 303, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7240,7 +7241,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 304, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7321,7 +7322,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 305, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7388,7 +7389,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 307, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7471,7 +7472,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 235, + "weight": 643, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7567,7 +7568,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 236, + "weight": 644, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7681,7 +7682,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 237, + "weight": 645, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7776,7 +7777,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 246, + "weight": 654, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7872,7 +7873,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 242, + "weight": 650, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -8003,7 +8004,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 243, + "weight": 651, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -8077,7 +8078,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 244, + "weight": 652, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8157,6 +8158,12 @@ "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false } } } @@ -8183,7 +8190,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 245, + "weight": 653, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8257,7 +8264,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 263, + "weight": 671, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8328,10 +8335,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint": { "post": { - "summary": "Create boolean attribute", - "operationId": "databasesCreateBooleanAttribute", + "summary": "Create bigint attribute", + "operationId": "databasesCreateBigIntAttribute", "consumes": [ "application\/json" ], @@ -8341,23 +8348,23 @@ "tags": [ "databases" ], - "description": "Create a boolean attribute.\n", + "description": "Create a bigint attribute. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "schema": { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/attributeBigint" } } }, "deprecated": true, "x-appwrite": { - "method": "createBooleanAttribute", + "method": "createBigIntAttribute", "group": "attributes", - "weight": 264, + "weight": 684, "cookies": false, "type": "", - "demo": "databases\/create-boolean-attribute.md", + "demo": "databases\/create-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8368,10 +8375,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createBooleanColumn" + "replaceWith": "tablesDB.createBigIntColumn" }, "auth": { "Project": [], @@ -8395,7 +8402,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": "", @@ -8419,11 +8426,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", "default": null, - "x-example": false, + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -8442,10 +8466,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/bigint\/{key}": { "patch": { - "summary": "Update boolean attribute", - "operationId": "databasesUpdateBooleanAttribute", + "summary": "Update bigint attribute", + "operationId": "databasesUpdateBigIntAttribute", "consumes": [ "application\/json" ], @@ -8455,23 +8479,23 @@ "tags": [ "databases" ], - "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a bigint attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeBoolean", + "description": "AttributeBigInt", "schema": { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/attributeBigint" } } }, "deprecated": true, "x-appwrite": { - "method": "updateBooleanAttribute", + "method": "updateBigIntAttribute", "group": "attributes", - "weight": 265, + "weight": 685, "cookies": false, "type": "", - "demo": "databases\/update-boolean-attribute.md", + "demo": "databases\/update-big-int-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8482,10 +8506,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-bigint-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateBooleanColumn" + "replaceWith": "tablesDB.updateBigIntColumn" }, "auth": { "Project": [], @@ -8509,7 +8533,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -8534,16 +8558,33 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "type": "integer", + "description": "Default value. Cannot be set when attribute is required.", "default": null, - "x-example": false, + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null, "x-nullable": true @@ -8558,10 +8599,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": { "post": { - "summary": "Create datetime attribute", - "operationId": "databasesCreateDatetimeAttribute", + "summary": "Create boolean attribute", + "operationId": "databasesCreateBooleanAttribute", "consumes": [ "application\/json" ], @@ -8571,23 +8612,23 @@ "tags": [ "databases" ], - "description": "Create a date time attribute according to the ISO 8601 standard.", + "description": "Create a boolean attribute.\n", "responses": { "202": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "schema": { - "$ref": "#\/definitions\/attributeDatetime" + "$ref": "#\/definitions\/attributeBoolean" } } }, "deprecated": true, "x-appwrite": { - "method": "createDatetimeAttribute", + "method": "createBooleanAttribute", "group": "attributes", - "weight": 266, + "weight": 672, "cookies": false, "type": "", - "demo": "databases\/create-datetime-attribute.md", + "demo": "databases\/create-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8598,10 +8639,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createDatetimeColumn" + "replaceWith": "tablesDB.createBooleanColumn" }, "auth": { "Project": [], @@ -8625,7 +8666,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -8650,10 +8691,10 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": null, + "x-example": false, "x-nullable": true }, "array": { @@ -8672,10 +8713,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": { "patch": { - "summary": "Update datetime attribute", - "operationId": "databasesUpdateDatetimeAttribute", + "summary": "Update boolean attribute", + "operationId": "databasesUpdateBooleanAttribute", "consumes": [ "application\/json" ], @@ -8685,23 +8726,23 @@ "tags": [ "databases" ], - "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeDatetime", + "description": "AttributeBoolean", "schema": { - "$ref": "#\/definitions\/attributeDatetime" + "$ref": "#\/definitions\/attributeBoolean" } } }, "deprecated": true, "x-appwrite": { - "method": "updateDatetimeAttribute", + "method": "updateBooleanAttribute", "group": "attributes", - "weight": 267, + "weight": 673, "cookies": false, "type": "", - "demo": "databases\/update-datetime-attribute.md", + "demo": "databases\/update-boolean-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8712,10 +8753,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateDatetimeColumn" + "replaceWith": "tablesDB.updateBooleanColumn" }, "auth": { "Project": [], @@ -8739,7 +8780,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -8765,10 +8806,10 @@ "x-example": false }, "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": null, + "x-example": false, "x-nullable": true }, "newKey": { @@ -8788,10 +8829,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": { "post": { - "summary": "Create email attribute", - "operationId": "databasesCreateEmailAttribute", + "summary": "Create datetime attribute", + "operationId": "databasesCreateDatetimeAttribute", "consumes": [ "application\/json" ], @@ -8801,23 +8842,23 @@ "tags": [ "databases" ], - "description": "Create an email attribute.\n", + "description": "Create a date time attribute according to the ISO 8601 standard.", "responses": { "202": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "schema": { - "$ref": "#\/definitions\/attributeEmail" + "$ref": "#\/definitions\/attributeDatetime" } } }, "deprecated": true, "x-appwrite": { - "method": "createEmailAttribute", + "method": "createDatetimeAttribute", "group": "attributes", - "weight": 268, + "weight": 674, "cookies": false, "type": "", - "demo": "databases\/create-email-attribute.md", + "demo": "databases\/create-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8828,10 +8869,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEmailColumn" + "replaceWith": "tablesDB.createDatetimeColumn" }, "auth": { "Project": [], @@ -8855,7 +8896,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "type": "string", "x-example": "", @@ -8881,10 +8922,10 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -8903,10 +8944,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": { "patch": { - "summary": "Update email attribute", - "operationId": "databasesUpdateEmailAttribute", + "summary": "Update datetime attribute", + "operationId": "databasesUpdateDatetimeAttribute", "consumes": [ "application\/json" ], @@ -8916,23 +8957,23 @@ "tags": [ "databases" ], - "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a date time attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeEmail", + "description": "AttributeDatetime", "schema": { - "$ref": "#\/definitions\/attributeEmail" + "$ref": "#\/definitions\/attributeDatetime" } } }, "deprecated": true, "x-appwrite": { - "method": "updateEmailAttribute", + "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 269, + "weight": 675, "cookies": false, "type": "", - "demo": "databases\/update-email-attribute.md", + "demo": "databases\/update-datetime-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8943,10 +8984,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateEmailColumn" + "replaceWith": "tablesDB.updateDatetimeColumn" }, "auth": { "Project": [], @@ -8999,13 +9040,13 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "default": null, "x-example": null, "x-nullable": true @@ -9020,10 +9061,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": { "post": { - "summary": "Create enum attribute", - "operationId": "databasesCreateEnumAttribute", + "summary": "Create email attribute", + "operationId": "databasesCreateEmailAttribute", "consumes": [ "application\/json" ], @@ -9033,23 +9074,23 @@ "tags": [ "databases" ], - "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "description": "Create an email attribute.\n", "responses": { "202": { - "description": "AttributeEnum", + "description": "AttributeEmail", "schema": { - "$ref": "#\/definitions\/attributeEnum" + "$ref": "#\/definitions\/attributeEmail" } } }, "deprecated": true, "x-appwrite": { - "method": "createEnumAttribute", + "method": "createEmailAttribute", "group": "attributes", - "weight": 270, + "weight": 676, "cookies": false, "type": "", - "demo": "databases\/create-enum-attribute.md", + "demo": "databases\/create-email-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9060,10 +9101,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createEnumColumn" + "replaceWith": "tablesDB.createEmailColumn" }, "auth": { "Project": [], @@ -9105,15 +9146,6 @@ "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 attribute required?", @@ -9124,7 +9156,8 @@ "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "", + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "array": { @@ -9136,7 +9169,6 @@ }, "required": [ "key", - "elements", "required" ] } @@ -9144,10 +9176,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": { "patch": { - "summary": "Update enum attribute", - "operationId": "databasesUpdateEnumAttribute", + "summary": "Update email attribute", + "operationId": "databasesUpdateEmailAttribute", "consumes": [ "application\/json" ], @@ -9157,23 +9189,23 @@ "tags": [ "databases" ], - "description": "Update an enum attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeEnum", + "description": "AttributeEmail", "schema": { - "$ref": "#\/definitions\/attributeEnum" + "$ref": "#\/definitions\/attributeEmail" } } }, "deprecated": true, "x-appwrite": { - "method": "updateEnumAttribute", + "method": "updateEmailAttribute", "group": "attributes", - "weight": 271, + "weight": 677, "cookies": false, "type": "", - "demo": "databases\/update-enum-attribute.md", + "demo": "databases\/update-email-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9184,10 +9216,251 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateEnumColumn" + "replaceWith": "tablesDB.updateEmailColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": { + "post": { + "summary": "Create enum attribute", + "operationId": "databasesCreateEnumAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n", + "responses": { + "202": { + "description": "AttributeEnum", + "schema": { + "$ref": "#\/definitions\/attributeEnum" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "createEnumAttribute", + "group": "attributes", + "weight": 678, + "cookies": false, + "type": "", + "demo": "databases\/create-enum-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createEnumColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute 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 attribute required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}": { + "patch": { + "summary": "Update enum attribute", + "operationId": "databasesUpdateEnumAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update an enum attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeEnum", + "schema": { + "$ref": "#\/definitions\/attributeEnum" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateEnumAttribute", + "group": "attributes", + "weight": 679, + "cookies": false, + "type": "", + "demo": "databases\/update-enum-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateEnumColumn" }, "auth": { "Project": [], @@ -9296,7 +9569,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 272, + "weight": 680, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9427,7 +9700,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 273, + "weight": 681, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9560,7 +9833,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 274, + "weight": 682, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9691,7 +9964,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 275, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9824,7 +10097,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 276, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9938,7 +10211,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 277, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -10054,7 +10327,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 278, + "weight": 688, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10162,7 +10435,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 279, + "weight": 689, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10277,7 +10550,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 296, + "weight": 706, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10393,7 +10666,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 297, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10505,7 +10778,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 294, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10621,7 +10894,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 295, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10733,7 +11006,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 280, + "weight": 690, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10841,7 +11114,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 281, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10956,7 +11229,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 282, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -11064,7 +11337,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 283, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11179,7 +11452,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11321,7 +11594,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -11433,7 +11706,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 696, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -11561,7 +11834,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 697, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -11685,7 +11958,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 292, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -11801,7 +12074,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 293, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -11913,7 +12186,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -12028,7 +12301,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -12145,7 +12418,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 290, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -12269,7 +12542,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 291, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -12418,7 +12691,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 261, + "weight": 669, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -12494,7 +12767,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 262, + "weight": 670, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -12575,7 +12848,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 257, + "weight": 665, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12656,7 +12929,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "type": "integer", "format": "int32", @@ -12691,7 +12964,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 249, + "weight": 657, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12886,7 +13159,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 254, + "weight": 662, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -13023,7 +13296,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 252, + "weight": 660, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13128,7 +13401,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 256, + "weight": 664, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13227,7 +13500,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 250, + "weight": 658, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13332,7 +13605,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 253, + "weight": 661, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13486,7 +13759,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 251, + "weight": 659, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13598,7 +13871,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 255, + "weight": 663, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13701,7 +13974,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 260, + "weight": 668, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13826,7 +14099,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 259, + "weight": 667, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -13949,7 +14222,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 301, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14044,7 +14317,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 298, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14185,7 +14458,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 299, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14261,7 +14534,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 300, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14342,7 +14615,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 385, + "weight": 797, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -14426,7 +14699,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 381, + "weight": 793, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -14511,7 +14784,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 415, + "weight": 827, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -14580,7 +14853,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 411, + "weight": 823, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -14653,7 +14926,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 412, + "weight": 824, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -14718,7 +14991,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 413, + "weight": 825, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -14799,7 +15072,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 414, + "weight": 826, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -14866,7 +15139,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 416, + "weight": 828, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -14948,7 +15221,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 382, + "weight": 794, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -15010,7 +15283,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 383, + "weight": 795, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -15091,7 +15364,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 384, + "weight": 796, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -15153,7 +15426,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 392, + "weight": 804, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -15245,7 +15518,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 388, + "weight": 800, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -15372,7 +15645,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 389, + "weight": 801, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -15442,7 +15715,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 390, + "weight": 802, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -15517,6 +15790,12 @@ "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false } }, "required": [ @@ -15546,7 +15825,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 391, + "weight": 803, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -15616,7 +15895,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 407, + "weight": 819, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -15728,7 +16007,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 399, + "weight": 811, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -15907,7 +16186,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 404, + "weight": 816, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -16035,7 +16314,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 402, + "weight": 814, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -16135,7 +16414,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 406, + "weight": 818, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -16229,7 +16508,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 400, + "weight": 812, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -16330,7 +16609,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 403, + "weight": 815, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -16474,7 +16753,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 401, + "weight": 813, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -16580,7 +16859,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 405, + "weight": 817, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -16678,7 +16957,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 410, + "weight": 822, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -16797,7 +17076,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 409, + "weight": 821, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -16914,7 +17193,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 398, + "weight": 810, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -17005,7 +17284,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 395, + "weight": 807, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -17068,8 +17347,7 @@ "enum": [ "key", "fulltext", - "unique", - "spatial" + "unique" ], "x-enum-name": "DocumentsDBIndexType", "x-enum-keys": [] @@ -17142,7 +17420,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 396, + "weight": 808, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -17214,7 +17492,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 397, + "weight": 809, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -17291,7 +17569,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 468, + "weight": 463, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -17374,7 +17652,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 628, + "weight": 864, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -17475,6 +17753,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -17512,7 +17791,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -17641,6 +17921,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -17739,7 +18023,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 470, + "weight": 465, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -17790,7 +18074,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 471, + "weight": 466, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -17841,7 +18125,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 466, + "weight": 461, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -17902,7 +18186,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 629, + "weight": 865, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -18005,6 +18289,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -18042,7 +18327,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -18171,6 +18457,10 @@ "webhooks.write", "project.read", "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", "policies.write", "policies.read", "archives.read", @@ -18263,7 +18553,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 469, + "weight": 464, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -18326,7 +18616,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 474, + "weight": 469, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -18405,7 +18695,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 475, + "weight": 470, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -18496,7 +18786,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 472, + "weight": 467, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -18590,7 +18880,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 480, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -18677,7 +18967,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 477, + "weight": 472, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -18799,7 +19089,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 478, + "weight": 473, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -18897,7 +19187,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 473, + "weight": 468, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -18961,7 +19251,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 476, + "weight": 471, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -19030,7 +19320,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 479, + "weight": 474, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -19117,7 +19407,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 481, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -19186,7 +19476,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 484, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -19271,7 +19561,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 482, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -19392,7 +19682,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 483, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -19459,7 +19749,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 485, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -19528,7 +19818,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 490, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -19589,7 +19879,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 630, + "weight": 866, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -19681,7 +19971,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 489, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -19750,7 +20040,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 491, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -19846,7 +20136,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 492, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -19917,7 +20207,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 150, + "weight": 140, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -19994,7 +20284,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 149, + "weight": 139, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -20069,7 +20359,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 495, + "weight": 490, "cookies": false, "type": "", "demo": "health\/get.md", @@ -20121,7 +20411,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 504, + "weight": 499, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -20173,7 +20463,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 498, + "weight": 493, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -20225,7 +20515,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 501, + "weight": 496, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -20286,7 +20576,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 762, + "weight": 1004, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -20358,7 +20648,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 497, + "weight": 492, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -20410,7 +20700,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 499, + "weight": 494, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -20449,7 +20739,7 @@ "tags": [ "health" ], - "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.", + "description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.\n", "responses": { "200": { "description": "Health Queue", @@ -20462,7 +20752,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 505, + "weight": 500, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -20525,7 +20815,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 758, + "weight": 1000, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -20588,7 +20878,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 757, + "weight": 999, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -20651,7 +20941,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 509, + "weight": 504, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -20714,7 +21004,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 759, + "weight": 1001, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -20777,7 +21067,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 508, + "weight": 503, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -20840,7 +21130,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 510, + "weight": 505, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -20912,7 +21202,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 511, + "weight": 506, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -20975,7 +21265,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 518, + "weight": 513, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -21063,7 +21353,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 515, + "weight": 510, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -21126,7 +21416,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 507, + "weight": 502, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -21189,7 +21479,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 512, + "weight": 507, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -21252,7 +21542,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 513, + "weight": 508, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -21315,7 +21605,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 514, + "weight": 509, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -21378,7 +21668,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 760, + "weight": 1002, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -21441,7 +21731,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 516, + "weight": 511, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -21504,7 +21794,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 517, + "weight": 512, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -21567,7 +21857,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 761, + "weight": 1003, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -21630,7 +21920,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 506, + "weight": 501, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -21693,7 +21983,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 503, + "weight": 498, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -21745,7 +22035,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 502, + "weight": 497, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -21797,7 +22087,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 500, + "weight": 495, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -22289,7 +22579,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 205, + "weight": 197, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -22375,7 +22665,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 202, + "weight": 194, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -22496,7 +22786,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -22536,7 +22827,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 209, + "weight": 201, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -22659,7 +22950,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "attachments": { @@ -22704,7 +22996,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 204, + "weight": 196, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -22842,7 +23134,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -22904,7 +23197,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 211, + "weight": 203, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -23057,7 +23350,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "contentAvailable": { @@ -23119,7 +23413,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 203, + "weight": 195, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -23273,7 +23567,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } }, @@ -23312,7 +23607,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 210, + "weight": 202, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -23471,7 +23766,8 @@ "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -23504,7 +23800,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 208, + "weight": 200, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -23561,7 +23857,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 212, + "weight": 204, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -23623,7 +23919,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 206, + "weight": 198, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -23706,7 +24002,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 207, + "weight": 199, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -23789,7 +24085,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 176, + "weight": 168, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -23875,7 +24171,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 175, + "weight": 167, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -24067,7 +24363,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 189, + "weight": 181, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -24256,7 +24552,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 174, + "weight": 166, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -24417,7 +24713,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 188, + "weight": 180, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -24574,7 +24870,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 165, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -24707,7 +25003,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 179, + "weight": 171, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -24837,7 +25133,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 169, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -24943,7 +25239,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 183, + "weight": 175, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -25047,7 +25343,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 167, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -25167,7 +25463,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 181, + "weight": 173, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -25284,7 +25580,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 166, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -25404,7 +25700,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 180, + "weight": 172, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -25521,7 +25817,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 168, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -25774,7 +26070,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 182, + "weight": 174, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -26021,7 +26317,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 170, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -26128,7 +26424,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 184, + "weight": 176, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -26232,7 +26528,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 171, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -26339,7 +26635,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 185, + "weight": 177, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -26443,7 +26739,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 172, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -26550,7 +26846,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 186, + "weight": 178, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -26654,7 +26950,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 173, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -26761,7 +27057,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 187, + "weight": 179, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -26863,7 +27159,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 178, + "weight": 170, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -26920,7 +27216,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 190, + "weight": 182, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -26982,7 +27278,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 177, + "weight": 169, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -27065,7 +27361,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 199, + "weight": 191, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -27148,7 +27444,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 192, + "weight": 184, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -27232,7 +27528,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 191, + "weight": 183, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -27322,7 +27618,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 194, + "weight": 186, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -27384,7 +27680,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 195, + "weight": 187, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -27467,7 +27763,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 196, + "weight": 188, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -27529,7 +27825,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 193, + "weight": 185, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -27612,7 +27908,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 198, + "weight": 190, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -27704,7 +28000,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 197, + "weight": 189, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -27794,7 +28090,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 200, + "weight": 192, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -27859,7 +28155,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 201, + "weight": 193, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -27908,38 +28204,40 @@ ] } }, - "\/project\/variables": { - "get": { - "summary": "List project variables", - "operationId": "projectListVariables", - "consumes": [], + "\/project\/auth\/canonical-emails": { + "patch": { + "summary": "Update project auth canonical emails", + "operationId": "projectUpdateCanonicalEmails", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", "responses": { "200": { - "description": "Variables List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/variableList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 623, + "method": "updateCanonicalEmails", + "group": "auth", + "weight": 1072, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/update-canonical-emails.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "project.write", "platforms": [ "console", "server" @@ -27959,31 +28257,103 @@ ], "parameters": [ { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to require canonical email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/auth\/disposable-emails": { + "patch": { + "summary": "Update project auth disposable emails", + "operationId": "projectUpdateDisposableEmails", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDisposableEmails", + "group": "auth", + "weight": 1073, + "cookies": false, + "type": "", + "demo": "project\/update-disposable-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] - }, - "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", + } + }, + "\/project\/auth\/free-emails": { + "patch": { + "summary": "Update project auth free emails", + "operationId": "projectUpdateFreeEmails", "consumes": [ "application\/json" ], @@ -27993,23 +28363,1866 @@ "tags": [ "project" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "Project", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 622, + "method": "updateFreeEmails", + "group": "auth", + "weight": 1074, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/update-free-emails.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, + "\/project\/keys": { + "get": { + "summary": "List project keys", + "operationId": "projectListKeys", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a list of all API keys from the current project.", + "responses": { + "200": { + "description": "API Keys List", + "schema": { + "$ref": "#\/definitions\/keyList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listKeys", + "group": "keys", + "weight": 1055, + "cookies": false, + "type": "", + "demo": "project\/list-keys.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire, accessedAt, name, scopes", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create project key", + "operationId": "projectCreateKey", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "responses": { + "201": { + "description": "Key", + "schema": { + "$ref": "#\/definitions\/key" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createKey", + "group": "keys", + "weight": 1054, + "cookies": false, + "type": "", + "demo": "project\/create-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "keyId": { + "type": "string", + "description": "Key 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": "Key name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "default": null, + "x-example": null, + "x-nullable": true, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + } + }, + "required": [ + "keyId", + "name", + "scopes" + ] + } + } + ] + } + }, + "\/project\/keys\/{keyId}": { + "get": { + "summary": "Get project key", + "operationId": "projectGetKey", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a key by its unique ID. ", + "responses": { + "200": { + "description": "Key", + "schema": { + "$ref": "#\/definitions\/key" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getKey", + "group": "keys", + "weight": 1056, + "cookies": false, + "type": "", + "demo": "project\/get-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "keyId", + "description": "Key ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update project key", + "operationId": "projectUpdateKey", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.", + "responses": { + "200": { + "description": "Key", + "schema": { + "$ref": "#\/definitions\/key" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateKey", + "group": "keys", + "weight": 1058, + "cookies": false, + "type": "", + "demo": "project\/update-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "keyId", + "description": "Key ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Key name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "default": null, + "x-example": null, + "x-nullable": true, + "items": { + "type": "string", + "enum": [ + "sessions.write", + "users.read", + "users.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "collections.read", + "collections.write", + "tables.read", + "tables.write", + "attributes.read", + "attributes.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "documents.read", + "documents.write", + "rows.read", + "rows.write", + "files.read", + "files.write", + "buckets.read", + "buckets.write", + "functions.read", + "functions.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "execution.read", + "execution.write", + "locale.read", + "avatars.read", + "health.read", + "providers.read", + "providers.write", + "messages.read", + "messages.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "rules.read", + "rules.write", + "schedules.read", + "schedules.write", + "migrations.read", + "migrations.write", + "vcs.read", + "vcs.write", + "assistant.read", + "tokens.read", + "tokens.write", + "webhooks.read", + "webhooks.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "policies.write", + "policies.read", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + } + }, + "required": [ + "name", + "scopes" + ] + } + } + ] + }, + "delete": { + "summary": "Delete project key", + "operationId": "projectDeleteKey", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "project" + ], + "description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteKey", + "group": "keys", + "weight": 1057, + "cookies": false, + "type": "", + "demo": "project\/delete-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "keyId", + "description": "Key ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/project\/labels": { + "put": { + "summary": "Update project labels", + "operationId": "projectUpdateLabels", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the project labels. Labels can be used to easily filter projects in an organization.", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateLabels", + "group": null, + "weight": 1048, + "cookies": false, + "type": "", + "demo": "project\/update-labels.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "labels": { + "type": "array", + "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + } + }, + "required": [ + "labels" + ] + } + } + ] + } + }, + "\/project\/platforms": { + "get": { + "summary": "List project platforms", + "operationId": "projectListPlatforms", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "responses": { + "200": { + "description": "Platforms List", + "schema": { + "$ref": "#\/definitions\/platformList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listPlatforms", + "group": "platforms", + "weight": 1071, + "cookies": false, + "type": "", + "demo": "project\/list-platforms.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/project\/platforms\/android": { + "post": { + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Android", + "schema": { + "$ref": "#\/definitions\/platformAndroid" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1067, + "cookies": false, + "type": "", + "demo": "project\/create-android-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "applicationId" + ] + } + } + ] + } + }, + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", + "responses": { + "200": { + "description": "Platform Android", + "schema": { + "$ref": "#\/definitions\/platformAndroid" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1062, + "cookies": false, + "type": "", + "demo": "project\/update-android-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } + } + ] + } + }, + "\/project\/platforms\/apple": { + "post": { + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Apple", + "schema": { + "$ref": "#\/definitions\/platformApple" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createApplePlatform", + "group": "platforms", + "weight": 1066, + "cookies": false, + "type": "", + "demo": "project\/create-apple-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "bundleIdentifier" + ] + } + } + ] + } + }, + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", + "responses": { + "200": { + "description": "Platform Apple", + "schema": { + "$ref": "#\/definitions\/platformApple" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1061, + "cookies": false, + "type": "", + "demo": "project\/update-apple-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } + } + ] + } + }, + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Linux", + "schema": { + "$ref": "#\/definitions\/platformLinux" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1069, + "cookies": false, + "type": "", + "demo": "project\/create-linux-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageName" + ] + } + } + ] + } + }, + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", + "responses": { + "200": { + "description": "Platform Linux", + "schema": { + "$ref": "#\/definitions\/platformLinux" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1064, + "cookies": false, + "type": "", + "demo": "project\/update-linux-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "packageName" + ] + } + } + ] + } + }, + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Web", + "schema": { + "$ref": "#\/definitions\/platformWeb" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createWebPlatform", + "group": "platforms", + "weight": 1065, + "cookies": false, + "type": "", + "demo": "project\/create-web-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": "", + "x-example": null + } + }, + "required": [ + "platformId", + "name" + ] + } + } + ] + } + }, + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", + "responses": { + "200": { + "description": "Platform Web", + "schema": { + "$ref": "#\/definitions\/platformWeb" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1060, + "cookies": false, + "type": "", + "demo": "project\/update-web-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": "", + "x-example": null + } + }, + "required": [ + "name" + ] + } + } + ] + } + }, + "\/project\/platforms\/windows": { + "post": { + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", + "responses": { + "201": { + "description": "Platform Windows", + "schema": { + "$ref": "#\/definitions\/platformWindows" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1068, + "cookies": false, + "type": "", + "demo": "project\/create-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform 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": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageIdentifierName" + ] + } + } + ] + } + }, + "\/project\/platforms\/windows\/{platformId}": { + "put": { + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", + "responses": { + "200": { + "description": "Platform Windows", + "schema": { + "$ref": "#\/definitions\/platformWindows" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1063, + "cookies": false, + "type": "", + "demo": "project\/update-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "packageIdentifierName" + ] + } + } + ] + } + }, + "\/project\/platforms\/{platformId}": { + "get": { + "summary": "Get project platform", + "operationId": "projectGetPlatform", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", + "responses": { + "200": { + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ] + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getPlatform", + "group": "platforms", + "weight": 1070, + "cookies": false, + "type": "", + "demo": "project\/get-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "project" + ], + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deletePlatform", + "group": "platforms", + "weight": 1059, + "cookies": false, + "type": "", + "demo": "project\/delete-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/project\/variables": { + "get": { + "summary": "List project variables", + "operationId": "projectListVariables", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a list of all project environment variables.", + "responses": { + "200": { + "description": "Variables List", + "schema": { + "$ref": "#\/definitions\/variableList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listVariables", + "group": "variables", + "weight": 1050, + "cookies": false, + "type": "", + "demo": "project\/list-variables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create project variable", + "operationId": "projectCreateVariable", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "responses": { + "201": { + "description": "Variable", + "schema": { + "$ref": "#\/definitions\/variable" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createVariable", + "group": "variables", + "weight": 1049, + "cookies": false, + "type": "", + "demo": "project\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -28041,7 +30254,7 @@ "variableId": { "type": "string", "description": "Variable 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, + "default": "unique()", "x-example": "" }, "key": { @@ -28064,7 +30277,6 @@ } }, "required": [ - "variableId", "key", "value" ] @@ -28097,7 +30309,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 624, + "weight": 1051, "cookies": false, "type": "", "demo": "project\/get-variable.md", @@ -28158,7 +30370,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 626, + "weight": 1053, "cookies": false, "type": "", "demo": "project\/update-variable.md", @@ -28244,7 +30456,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 625, + "weight": 1052, "cookies": false, "type": "", "demo": "project\/delete-variable.md", @@ -28305,7 +30517,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 522, + "weight": 517, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -28388,7 +30600,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 631, + "weight": 867, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -28557,6 +30769,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -28594,7 +30807,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -28702,7 +30916,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 525, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -28753,7 +30967,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 548, + "weight": 543, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -28804,7 +31018,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 521, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -28865,7 +31079,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 632, + "weight": 868, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -29036,6 +31250,7 @@ "dart-3.8", "dart-3.9", "dart-3.10", + "dart-3.11", "dotnet-6.0", "dotnet-7.0", "dotnet-8.0", @@ -29073,7 +31288,8 @@ "flutter-3.29", "flutter-3.32", "flutter-3.35", - "flutter-3.38" + "flutter-3.38", + "flutter-3.41" ], "x-enum-name": null, "x-enum-keys": [] @@ -29174,7 +31390,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 524, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -29237,7 +31453,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 531, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -29316,7 +31532,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 530, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -29407,7 +31623,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 526, + "weight": 521, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -29510,7 +31726,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 534, + "weight": 529, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -29591,7 +31807,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 527, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -29713,7 +31929,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 528, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -29812,7 +32028,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 529, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -29876,7 +32092,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 532, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -29945,7 +32161,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 533, + "weight": 528, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -30032,7 +32248,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 535, + "weight": 530, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -30101,7 +32317,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 537, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -30183,7 +32399,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 536, + "weight": 531, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -30249,7 +32465,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 538, + "weight": 533, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -30318,7 +32534,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 541, + "weight": 536, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -30379,7 +32595,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 633, + "weight": 869, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -30471,7 +32687,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 540, + "weight": 535, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -30540,7 +32756,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 542, + "weight": 537, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -30636,7 +32852,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 543, + "weight": 538, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -30705,7 +32921,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 589, + "weight": 584, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -30789,7 +33005,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 587, + "weight": 582, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -30937,7 +33153,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 588, + "weight": 583, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -30999,7 +33215,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 590, + "weight": 585, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -31143,7 +33359,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 591, + "weight": 586, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -31205,7 +33421,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 594, + "weight": 589, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -31300,7 +33516,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 808, + "weight": 1077, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -31393,7 +33609,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 593, + "weight": 588, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -31466,7 +33682,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 595, + "weight": 590, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -31559,7 +33775,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 596, + "weight": 591, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -31632,7 +33848,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 598, + "weight": 593, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -31714,7 +33930,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 597, + "weight": 592, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -31924,7 +34140,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 599, + "weight": 594, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -32006,7 +34222,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 312, + "weight": 722, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -32090,7 +34306,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 308, + "weight": 718, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -32175,7 +34391,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 379, + "weight": 791, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -32247,7 +34463,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 375, + "weight": 787, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -32323,7 +34539,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 376, + "weight": 788, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -32391,7 +34607,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 377, + "weight": 789, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -32475,7 +34691,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 378, + "weight": 790, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -32545,7 +34761,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 380, + "weight": 792, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -32631,7 +34847,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 309, + "weight": 719, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -32693,7 +34909,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 310, + "weight": 720, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -32771,7 +34987,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 311, + "weight": 721, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -32833,7 +35049,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 319, + "weight": 729, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -32928,7 +35144,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 315, + "weight": 725, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -33058,7 +35274,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 316, + "weight": 726, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -33131,7 +35347,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 317, + "weight": 727, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -33183,142 +35399,374 @@ "schema": { "type": "object", "properties": { - "name": { + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "rowSecurity": { + "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 + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tablesDB" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTable", + "group": "tables", + "weight": 728, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "List columns in the table.", + "responses": { + "200": { + "description": "Columns List", + "schema": { + "$ref": "#\/definitions\/columnList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listColumns", + "group": "columns", + "weight": 734, + "cookies": false, + "type": "", + "demo": "tablesdb\/list-columns.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.read", + "collections.read" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint": { + "post": { + "summary": "Create bigint column", + "operationId": "tablesDBCreateBigIntColumn", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "Create a bigint column. Optionally, minimum and maximum values can be provided.\n", + "responses": { + "202": { + "description": "ColumnBigInt", + "schema": { + "$ref": "#\/definitions\/columnBigint" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBigIntColumn", + "group": "columns", + "weight": 747, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-big-int-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-bigint-column.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { "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).", + "description": "Column Key.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": null }, - "rowSecurity": { + "required": { "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, + "description": "Is column required?", + "default": null, "x-example": false }, - "enabled": { + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "default": true, + "description": "Is column an array?", + "default": false, "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/bigint\/{key}": { + "patch": { + "summary": "Update bigint column", + "operationId": "tablesDBUpdateBigIntColumn", "consumes": [ "application\/json" ], - "produces": [], - "tags": [ - "tablesDB" - ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 318, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-table.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Update a bigint column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Columns List", + "description": "ColumnBigInt", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/columnBigint" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", + "method": "updateBigIntColumn", "group": "columns", - "weight": 324, + "weight": 748, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/update-big-int-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "tables.write", + "collections.write" ], "platforms": [ "console", @@ -33326,7 +35774,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-bigint-column.md", "auth": { "Project": [], "Key": [] @@ -33356,25 +35804,61 @@ "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "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, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } @@ -33405,7 +35889,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 325, + "weight": 735, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -33518,7 +36002,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 326, + "weight": 736, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -33633,7 +36117,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 327, + "weight": 737, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -33701,7 +36185,8 @@ "type": "string", "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "array": { @@ -33746,7 +36231,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 328, + "weight": 738, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -33815,7 +36300,8 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, "newKey": { @@ -33861,7 +36347,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 329, + "weight": 739, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -33975,7 +36461,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 330, + "weight": 740, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -34091,7 +36577,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 331, + "weight": 741, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -34214,7 +36700,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 332, + "weight": 742, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -34339,7 +36825,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 333, + "weight": 743, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -34469,7 +36955,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 334, + "weight": 744, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -34601,7 +37087,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 335, + "weight": 745, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -34731,7 +37217,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 336, + "weight": 746, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -34863,7 +37349,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 337, + "weight": 749, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -34976,7 +37462,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 338, + "weight": 750, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -35091,7 +37577,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 339, + "weight": 751, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -35198,7 +37684,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 340, + "weight": 752, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -35312,7 +37798,7 @@ "x-appwrite": { "method": "createLongtextColumn", "group": "columns", - "weight": 357, + "weight": 769, "cookies": false, "type": "", "demo": "tablesdb\/create-longtext-column.md", @@ -35431,7 +37917,7 @@ "x-appwrite": { "method": "updateLongtextColumn", "group": "columns", - "weight": 358, + "weight": 770, "cookies": false, "type": "", "demo": "tablesdb\/update-longtext-column.md", @@ -35546,7 +38032,7 @@ "x-appwrite": { "method": "createMediumtextColumn", "group": "columns", - "weight": 355, + "weight": 767, "cookies": false, "type": "", "demo": "tablesdb\/create-mediumtext-column.md", @@ -35665,7 +38151,7 @@ "x-appwrite": { "method": "updateMediumtextColumn", "group": "columns", - "weight": 356, + "weight": 768, "cookies": false, "type": "", "demo": "tablesdb\/update-mediumtext-column.md", @@ -35780,7 +38266,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 341, + "weight": 753, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -35887,7 +38373,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 342, + "weight": 754, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -36001,7 +38487,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 343, + "weight": 755, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -36108,7 +38594,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 344, + "weight": 756, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -36222,7 +38708,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 345, + "weight": 757, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -36363,7 +38849,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 347, + "weight": 759, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -36494,7 +38980,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 348, + "weight": 760, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -36621,7 +39107,7 @@ "x-appwrite": { "method": "createTextColumn", "group": "columns", - "weight": 353, + "weight": 765, "cookies": false, "type": "", "demo": "tablesdb\/create-text-column.md", @@ -36740,7 +39226,7 @@ "x-appwrite": { "method": "updateTextColumn", "group": "columns", - "weight": 354, + "weight": 766, "cookies": false, "type": "", "demo": "tablesdb\/update-text-column.md", @@ -36855,7 +39341,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 349, + "weight": 761, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -36969,7 +39455,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 350, + "weight": 762, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -37085,7 +39571,7 @@ "x-appwrite": { "method": "createVarcharColumn", "group": "columns", - "weight": 351, + "weight": 763, "cookies": false, "type": "", "demo": "tablesdb\/create-varchar-column.md", @@ -37212,7 +39698,7 @@ "x-appwrite": { "method": "updateVarcharColumn", "group": "columns", - "weight": 352, + "weight": 764, "cookies": false, "type": "", "demo": "tablesdb\/update-varchar-column.md", @@ -37364,7 +39850,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 322, + "weight": 732, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -37439,7 +39925,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 323, + "weight": 733, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -37521,7 +40007,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 346, + "weight": 758, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -37631,7 +40117,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 362, + "weight": 774, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -37725,7 +40211,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 359, + "weight": 771, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -37865,7 +40351,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 360, + "weight": 772, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -37940,7 +40426,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 361, + "weight": 773, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -38020,7 +40506,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 371, + "weight": 783, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -38100,7 +40586,7 @@ }, { "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", "required": false, "type": "integer", "format": "int32", @@ -38135,7 +40621,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 363, + "weight": 775, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -38321,7 +40807,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 368, + "weight": 780, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -38453,7 +40939,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 366, + "weight": 778, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -38557,7 +41043,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 370, + "weight": 782, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -38655,7 +41141,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 364, + "weight": 776, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -38759,7 +41245,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 367, + "weight": 779, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -38908,7 +41394,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 365, + "weight": 777, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -39019,7 +41505,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 369, + "weight": 781, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -39121,7 +41607,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 374, + "weight": 786, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -39245,7 +41731,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 373, + "weight": 785, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -39367,7 +41853,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 570, + "weight": 565, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -39454,7 +41940,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 568, + "weight": 563, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -39547,7 +42033,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 569, + "weight": 564, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -39612,7 +42098,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 572, + "weight": 567, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -39690,7 +42176,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 571, + "weight": 566, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -39755,7 +42241,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 577, + "weight": 572, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -39850,7 +42336,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 575, + "weight": 570, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -39969,7 +42455,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 576, + "weight": 571, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -40042,7 +42528,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 578, + "weight": 573, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -40131,7 +42617,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 809, + "weight": 1078, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -40206,7 +42692,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 580, + "weight": 575, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -40303,7 +42789,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 573, + "weight": 568, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -40367,7 +42853,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 574, + "weight": 569, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -40449,7 +42935,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 584, + "weight": 579, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -40539,7 +43025,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 582, + "weight": 577, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -40591,7 +43077,8 @@ "type": "string", "description": "Token expiry date", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -40624,7 +43111,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 583, + "weight": 578, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -40685,7 +43172,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 585, + "weight": 580, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -40729,7 +43216,8 @@ "type": "string", "description": "File token expiry date", "default": null, - "x-example": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true } } @@ -40757,7 +43245,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 586, + "weight": 581, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -40818,7 +43306,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 104, + "weight": 94, "cookies": false, "type": "", "demo": "users\/list.md", @@ -40902,7 +43390,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 95, + "weight": 85, "cookies": false, "type": "", "demo": "users\/create.md", @@ -41004,7 +43492,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 98, + "weight": 88, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -41100,7 +43588,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 96, + "weight": 86, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -41194,7 +43682,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 112, + "weight": 102, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -41275,7 +43763,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 136, + "weight": 126, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -41339,7 +43827,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 97, + "weight": 87, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -41435,7 +43923,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 100, + "weight": 90, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -41531,7 +44019,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 101, + "weight": 91, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -41666,7 +44154,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 102, + "weight": 92, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -41783,7 +44271,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 99, + "weight": 89, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -41898,7 +44386,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 105, + "weight": 95, "cookies": false, "type": "", "demo": "users\/get.md", @@ -41955,7 +44443,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 134, + "weight": 124, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -42019,7 +44507,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 119, + "weight": 109, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -42102,7 +44590,7 @@ "x-appwrite": { "method": "updateImpersonator", "group": "users", - "weight": 115, + "weight": 105, "cookies": false, "type": "", "demo": "users\/update-impersonator.md", @@ -42184,7 +44672,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 137, + "weight": 127, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -42270,7 +44758,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 114, + "weight": 104, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -42353,7 +44841,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 110, + "weight": 100, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -42436,7 +44924,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 109, + "weight": 99, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -42530,7 +45018,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 124, + "weight": 114, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -42669,7 +45157,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 129, + "weight": 119, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -42804,7 +45292,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 125, + "weight": 115, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -42924,7 +45412,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 126, + "weight": 116, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -43044,7 +45532,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 128, + "weight": 118, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -43164,7 +45652,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 127, + "weight": 117, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -43286,7 +45774,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 117, + "weight": 107, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -43368,7 +45856,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 118, + "weight": 108, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -43450,7 +45938,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 120, + "weight": 110, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -43531,7 +46019,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 106, + "weight": 96, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -43593,7 +46081,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 122, + "weight": 112, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -43673,7 +46161,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 108, + "weight": 98, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -43744,7 +46232,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 130, + "weight": 120, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -43801,7 +46289,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 133, + "weight": 123, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -43860,7 +46348,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 132, + "weight": 122, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -43932,7 +46420,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 113, + "weight": 103, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -44012,7 +46500,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 111, + "weight": 101, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -44095,7 +46583,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 103, + "weight": 93, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -44208,7 +46696,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 107, + "weight": 97, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -44278,7 +46766,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 123, + "weight": 113, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -44370,7 +46858,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 135, + "weight": 125, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -44442,7 +46930,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 131, + "weight": 121, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -44529,7 +47017,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 121, + "weight": 111, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -44611,7 +47099,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 116, + "weight": 106, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -44691,7 +47179,7 @@ "x-appwrite": { "method": "list", "group": "vectorsdb", - "weight": 421, + "weight": 833, "cookies": false, "type": "", "demo": "vectorsdb\/list.md", @@ -44775,7 +47263,7 @@ "x-appwrite": { "method": "create", "group": "vectorsdb", - "weight": 417, + "weight": 829, "cookies": false, "type": "", "demo": "vectorsdb\/create.md", @@ -44862,7 +47350,7 @@ "x-appwrite": { "method": "createTextEmbeddings", "group": "documents", - "weight": 445, + "weight": 857, "cookies": false, "type": "", "demo": "vectorsdb\/create-text-embeddings.md", @@ -44976,7 +47464,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 450, + "weight": 862, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -45045,7 +47533,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 446, + "weight": 858, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -45118,7 +47606,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 447, + "weight": 859, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -45183,7 +47671,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 448, + "weight": 860, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -45264,7 +47752,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 449, + "weight": 861, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -45331,7 +47819,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 451, + "weight": 863, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -45414,7 +47902,7 @@ "x-appwrite": { "method": "get", "group": "vectorsdb", - "weight": 418, + "weight": 830, "cookies": false, "type": "", "demo": "vectorsdb\/get.md", @@ -45476,7 +47964,7 @@ "x-appwrite": { "method": "update", "group": "vectorsdb", - "weight": 419, + "weight": 831, "cookies": false, "type": "", "demo": "vectorsdb\/update.md", @@ -45557,7 +48045,7 @@ "x-appwrite": { "method": "delete", "group": "vectorsdb", - "weight": 420, + "weight": 832, "cookies": false, "type": "", "demo": "vectorsdb\/delete.md", @@ -45619,7 +48107,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 428, + "weight": 840, "cookies": false, "type": "", "demo": "vectorsdb\/list-collections.md", @@ -45711,7 +48199,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 424, + "weight": 836, "cookies": false, "type": "", "demo": "vectorsdb\/create-collection.md", @@ -45827,7 +48315,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 425, + "weight": 837, "cookies": false, "type": "", "demo": "vectorsdb\/get-collection.md", @@ -45897,7 +48385,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 426, + "weight": 838, "cookies": false, "type": "", "demo": "vectorsdb\/update-collection.md", @@ -46008,7 +48496,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 427, + "weight": 839, "cookies": false, "type": "", "demo": "vectorsdb\/delete-collection.md", @@ -46078,7 +48566,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 439, + "weight": 851, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -46190,7 +48678,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 435, + "weight": 847, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -46369,7 +48857,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 442, + "weight": 854, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-documents.md", @@ -46497,7 +48985,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 441, + "weight": 853, "cookies": false, "type": "", "demo": "vectorsdb\/update-documents.md", @@ -46597,7 +49085,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 443, + "weight": 855, "cookies": false, "type": "", "demo": "vectorsdb\/delete-documents.md", @@ -46691,7 +49179,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 438, + "weight": 850, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -46792,7 +49280,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 437, + "weight": 849, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -46936,7 +49424,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 436, + "weight": 848, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -47042,7 +49530,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 440, + "weight": 852, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", @@ -47138,7 +49626,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 434, + "weight": 846, "cookies": false, "type": "", "demo": "vectorsdb\/list-indexes.md", @@ -47229,7 +49717,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 431, + "weight": 843, "cookies": false, "type": "", "demo": "vectorsdb\/create-index.md", @@ -47368,7 +49856,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 432, + "weight": 844, "cookies": false, "type": "", "demo": "vectorsdb\/get-index.md", @@ -47440,7 +49928,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 433, + "weight": 845, "cookies": false, "type": "", "demo": "vectorsdb\/delete-index.md", @@ -47517,7 +50005,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 617, + "weight": 612, "cookies": false, "type": "", "demo": "webhooks\/list.md", @@ -47591,7 +50079,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 616, + "weight": 611, "cookies": false, "type": "", "demo": "webhooks\/create.md", @@ -47710,7 +50198,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 618, + "weight": 613, "cookies": false, "type": "", "demo": "webhooks\/get.md", @@ -47771,7 +50259,7 @@ "x-appwrite": { "method": "update", "group": null, - "weight": 620, + "weight": 615, "cookies": false, "type": "", "demo": "webhooks\/update.md", @@ -47886,7 +50374,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 619, + "weight": 614, "cookies": false, "type": "", "demo": "webhooks\/delete.md", @@ -47949,7 +50437,7 @@ "x-appwrite": { "method": "updateSignature", "group": null, - "weight": 621, + "weight": 616, "cookies": false, "type": "", "demo": "webhooks\/update-signature.md", @@ -48735,6 +51223,35 @@ "webhooks": "" } }, + "keyList": { + "description": "API Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of keys that matched your query.", + "x-example": 5, + "format": "int32" + }, + "keys": { + "type": "array", + "description": "List of keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/key" + }, + "x-example": "" + } + }, + "required": [ + "total", + "keys" + ], + "example": { + "total": 5, + "keys": "" + } + }, "countryList": { "description": "Countries List", "type": "object", @@ -49416,6 +51933,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -49539,6 +52059,9 @@ { "$ref": "#\/definitions\/attributeBoolean" }, + { + "$ref": "#\/definitions\/attributeBigint" + }, { "$ref": "#\/definitions\/attributeInteger" }, @@ -49795,6 +52318,104 @@ "default": 10 } }, + "attributeBigint": { + "description": "AttributeBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for 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" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "attributeFloat": { "description": "AttributeFloat", "type": "object", @@ -51547,6 +54168,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -51670,6 +54294,9 @@ { "$ref": "#\/definitions\/columnBoolean" }, + { + "$ref": "#\/definitions\/columnBigint" + }, { "$ref": "#\/definitions\/columnInteger" }, @@ -51926,6 +54553,104 @@ "default": 10 } }, + "columnBigint": { + "description": "ColumnBigInt", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "bigint" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "count", + "type": "bigint", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 + } + }, "columnFloat": { "description": "ColumnFloat", "type": "object", @@ -53701,6 +56426,11 @@ "description": "API mode when event triggered.", "x-example": "admin" }, + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" + }, "ip": { "type": "string", "description": "IP session in use when the session was created.", @@ -53788,6 +56518,7 @@ "userEmail", "userName", "mode", + "userType", "ip", "time", "osCode", @@ -53811,6 +56542,7 @@ "userEmail": "john@appwrite.io", "userName": "John Doe", "mode": "admin", + "userType": "user", "ip": "127.0.0.1", "time": "2020-10-15T06:38:00.000+00:00", "osCode": "Mac", @@ -56212,6 +58944,581 @@ "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, + "project": { + "description": "Project", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Project ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Project creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Project update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Project name.", + "x-example": "New Project" + }, + "description": { + "type": "string", + "description": "Project description.", + "x-example": "This is a new project." + }, + "teamId": { + "type": "string", + "description": "Project team ID.", + "x-example": "1592981250" + }, + "logo": { + "type": "string", + "description": "Project logo file ID.", + "x-example": "5f5c451b403cb" + }, + "url": { + "type": "string", + "description": "Project website URL.", + "x-example": "5f5c451b403cb" + }, + "legalName": { + "type": "string", + "description": "Company legal name.", + "x-example": "Company LTD." + }, + "legalCountry": { + "type": "string", + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", + "x-example": "US" + }, + "legalState": { + "type": "string", + "description": "State name.", + "x-example": "New York" + }, + "legalCity": { + "type": "string", + "description": "City name.", + "x-example": "New York City." + }, + "legalAddress": { + "type": "string", + "description": "Company Address.", + "x-example": "620 Eighth Avenue, New York, NY 10018" + }, + "legalTaxId": { + "type": "string", + "description": "Company Tax ID.", + "x-example": "131102020" + }, + "authDuration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 60, + "format": "int32" + }, + "authLimit": { + "type": "integer", + "description": "Max users allowed. 0 is unlimited.", + "x-example": 100, + "format": "int32" + }, + "authSessionsLimit": { + "type": "integer", + "description": "Max sessions allowed per user. 100 maximum.", + "x-example": 10, + "format": "int32" + }, + "authPasswordHistory": { + "type": "integer", + "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", + "x-example": 5, + "format": "int32" + }, + "authPasswordDictionary": { + "type": "boolean", + "description": "Whether or not to check user's password against most commonly used passwords.", + "x-example": true + }, + "authPersonalDataCheck": { + "type": "boolean", + "description": "Whether or not to check the user password for similarity with their personal data.", + "x-example": true + }, + "authDisposableEmails": { + "type": "boolean", + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true + }, + "authCanonicalEmails": { + "type": "boolean", + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true + }, + "authFreeEmails": { + "type": "boolean", + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true + }, + "authMockNumbers": { + "type": "array", + "description": "An array of mock numbers and their corresponding verification codes (OTPs).", + "items": { + "type": "object", + "$ref": "#\/definitions\/mockNumber" + }, + "x-example": [ + {} + ] + }, + "authSessionAlerts": { + "type": "boolean", + "description": "Whether or not to send session alert emails to users.", + "x-example": true + }, + "authMembershipsUserName": { + "type": "boolean", + "description": "Whether or not to show user names in the teams membership response.", + "x-example": true + }, + "authMembershipsUserEmail": { + "type": "boolean", + "description": "Whether or not to show user emails in the teams membership response.", + "x-example": true + }, + "authMembershipsMfa": { + "type": "boolean", + "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.", + "items": { + "type": "object", + "$ref": "#\/definitions\/authProvider" + }, + "x-example": [ + {} + ] + }, + "platforms": { + "type": "array", + "description": "List of Platforms.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ] + }, + "x-example": {} + }, + "webhooks": { + "type": "array", + "description": "List of Webhooks.", + "items": { + "type": "object", + "$ref": "#\/definitions\/webhook" + }, + "x-example": {} + }, + "keys": { + "type": "array", + "description": "List of API Keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/key" + }, + "x-example": {} + }, + "devKeys": { + "type": "array", + "description": "List of dev keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/devKey" + }, + "x-example": {} + }, + "smtpEnabled": { + "type": "boolean", + "description": "Status for custom SMTP", + "x-example": false + }, + "smtpSenderName": { + "type": "string", + "description": "SMTP sender name", + "x-example": "John Appwrite" + }, + "smtpSenderEmail": { + "type": "string", + "description": "SMTP sender email", + "x-example": "john@appwrite.io" + }, + "smtpReplyTo": { + "type": "string", + "description": "SMTP reply to email", + "x-example": "support@appwrite.io" + }, + "smtpHost": { + "type": "string", + "description": "SMTP server host name", + "x-example": "mail.appwrite.io" + }, + "smtpPort": { + "type": "integer", + "description": "SMTP server port", + "x-example": 25, + "format": "int32" + }, + "smtpUsername": { + "type": "string", + "description": "SMTP server username", + "x-example": "emailuser" + }, + "smtpPassword": { + "type": "string", + "description": "SMTP server password", + "x-example": "securepassword" + }, + "smtpSecure": { + "type": "string", + "description": "SMTP server secure protocol", + "x-example": "tls" + }, + "pingCount": { + "type": "integer", + "description": "Number of times the ping was received for this project.", + "x-example": 1, + "format": "int32" + }, + "pingedAt": { + "type": "string", + "description": "Last ping datetime in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "labels": { + "type": "array", + "description": "Labels for the project.", + "items": { + "type": "string" + }, + "x-example": [ + "vip" + ] + }, + "status": { + "type": "string", + "description": "Project status", + "x-example": "active" + }, + "authEmailPassword": { + "type": "boolean", + "description": "Email\/Password auth method status", + "x-example": true + }, + "authUsersAuthMagicURL": { + "type": "boolean", + "description": "Magic URL auth method status", + "x-example": true + }, + "authEmailOtp": { + "type": "boolean", + "description": "Email (OTP) auth method status", + "x-example": true + }, + "authAnonymous": { + "type": "boolean", + "description": "Anonymous auth method status", + "x-example": true + }, + "authInvites": { + "type": "boolean", + "description": "Invites auth method status", + "x-example": true + }, + "authJWT": { + "type": "boolean", + "description": "JWT auth method status", + "x-example": true + }, + "authPhone": { + "type": "boolean", + "description": "Phone auth method status", + "x-example": true + }, + "serviceStatusForAccount": { + "type": "boolean", + "description": "Account service status", + "x-example": true + }, + "serviceStatusForAvatars": { + "type": "boolean", + "description": "Avatars service status", + "x-example": true + }, + "serviceStatusForDatabases": { + "type": "boolean", + "description": "Databases (legacy) service status", + "x-example": true + }, + "serviceStatusForTablesdb": { + "type": "boolean", + "description": "TablesDB service status", + "x-example": true + }, + "serviceStatusForLocale": { + "type": "boolean", + "description": "Locale service status", + "x-example": true + }, + "serviceStatusForHealth": { + "type": "boolean", + "description": "Health service status", + "x-example": true + }, + "serviceStatusForStorage": { + "type": "boolean", + "description": "Storage service status", + "x-example": true + }, + "serviceStatusForTeams": { + "type": "boolean", + "description": "Teams service status", + "x-example": true + }, + "serviceStatusForUsers": { + "type": "boolean", + "description": "Users service status", + "x-example": true + }, + "serviceStatusForSites": { + "type": "boolean", + "description": "Sites service status", + "x-example": true + }, + "serviceStatusForFunctions": { + "type": "boolean", + "description": "Functions service status", + "x-example": true + }, + "serviceStatusForGraphql": { + "type": "boolean", + "description": "GraphQL service status", + "x-example": true + }, + "serviceStatusForMessaging": { + "type": "boolean", + "description": "Messaging service status", + "x-example": true + }, + "region": { + "type": "string", + "description": "Project region", + "x-example": "fra" + }, + "billingLimits": { + "type": "object", + "description": "Billing limits reached", + "x-example": "", + "items": { + "type": "object", + "$ref": "#\/definitions\/billingLimits" + } + }, + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "type": "object", + "$ref": "#\/definitions\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { + "type": "string", + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "description", + "teamId", + "logo", + "url", + "legalName", + "legalCountry", + "legalState", + "legalCity", + "legalAddress", + "legalTaxId", + "authDuration", + "authLimit", + "authSessionsLimit", + "authPasswordHistory", + "authPasswordDictionary", + "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", + "authMockNumbers", + "authSessionAlerts", + "authMembershipsUserName", + "authMembershipsUserEmail", + "authMembershipsMfa", + "authInvalidateSessions", + "oAuthProviders", + "platforms", + "webhooks", + "keys", + "devKeys", + "smtpEnabled", + "smtpSenderName", + "smtpSenderEmail", + "smtpReplyTo", + "smtpHost", + "smtpPort", + "smtpUsername", + "smtpPassword", + "smtpSecure", + "pingCount", + "pingedAt", + "labels", + "status", + "authEmailPassword", + "authUsersAuthMagicURL", + "authEmailOtp", + "authAnonymous", + "authInvites", + "authJWT", + "authPhone", + "serviceStatusForAccount", + "serviceStatusForAvatars", + "serviceStatusForDatabases", + "serviceStatusForTablesdb", + "serviceStatusForLocale", + "serviceStatusForHealth", + "serviceStatusForStorage", + "serviceStatusForTeams", + "serviceStatusForUsers", + "serviceStatusForSites", + "serviceStatusForFunctions", + "serviceStatusForGraphql", + "serviceStatusForMessaging", + "region", + "billingLimits", + "blocks", + "consoleAccessedAt" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "New Project", + "description": "This is a new project.", + "teamId": "1592981250", + "logo": "5f5c451b403cb", + "url": "5f5c451b403cb", + "legalName": "Company LTD.", + "legalCountry": "US", + "legalState": "New York", + "legalCity": "New York City.", + "legalAddress": "620 Eighth Avenue, New York, NY 10018", + "legalTaxId": "131102020", + "authDuration": 60, + "authLimit": 100, + "authSessionsLimit": 10, + "authPasswordHistory": 5, + "authPasswordDictionary": true, + "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, + "authMockNumbers": [ + {} + ], + "authSessionAlerts": true, + "authMembershipsUserName": true, + "authMembershipsUserEmail": true, + "authMembershipsMfa": true, + "authInvalidateSessions": true, + "oAuthProviders": [ + {} + ], + "platforms": {}, + "webhooks": {}, + "keys": {}, + "devKeys": {}, + "smtpEnabled": false, + "smtpSenderName": "John Appwrite", + "smtpSenderEmail": "john@appwrite.io", + "smtpReplyTo": "support@appwrite.io", + "smtpHost": "mail.appwrite.io", + "smtpPort": 25, + "smtpUsername": "emailuser", + "smtpPassword": "securepassword", + "smtpSecure": "tls", + "pingCount": 1, + "pingedAt": "2020-10-15T06:38:00.000+00:00", + "labels": [ + "vip" + ], + "status": "active", + "authEmailPassword": true, + "authUsersAuthMagicURL": true, + "authEmailOtp": true, + "authAnonymous": true, + "authInvites": true, + "authJWT": true, + "authPhone": true, + "serviceStatusForAccount": true, + "serviceStatusForAvatars": true, + "serviceStatusForDatabases": true, + "serviceStatusForTablesdb": true, + "serviceStatusForLocale": true, + "serviceStatusForHealth": true, + "serviceStatusForStorage": true, + "serviceStatusForTeams": true, + "serviceStatusForUsers": true, + "serviceStatusForSites": true, + "serviceStatusForFunctions": true, + "serviceStatusForGraphql": true, + "serviceStatusForMessaging": true, + "region": "fra", + "billingLimits": "", + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, "webhook": { "description": "Webhook", "type": "object", @@ -56323,6 +59630,563 @@ "attempts": 10 } }, + "key": { + "description": "Key", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Key ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Key name.", + "x-example": "My API Key" + }, + "expire": { + "type": "string", + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" + }, + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "devKey": { + "description": "DevKey", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Key ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Key name.", + "x-example": "Dev API Key" + }, + "expire": { + "type": "string", + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "secret", + "accessedAt", + "sdks" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Dev API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "mockNumber": { + "description": "Mock Number", + "type": "object", + "properties": { + "phone": { + "type": "string", + "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", + "x-example": "+1612842323" + }, + "otp": { + "type": "string", + "description": "Mock OTP for the number. ", + "x-example": "123456" + } + }, + "required": [ + "phone", + "otp" + ], + "example": { + "phone": "+1612842323", + "otp": "123456" + } + }, + "authProvider": { + "description": "AuthProvider", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Auth Provider.", + "x-example": "github" + }, + "name": { + "type": "string", + "description": "Auth Provider name.", + "x-example": "GitHub" + }, + "appId": { + "type": "string", + "description": "OAuth 2.0 application ID.", + "x-example": "259125845563242502" + }, + "secret": { + "type": "string", + "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.", + "x-example": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ" + }, + "enabled": { + "type": "boolean", + "description": "Auth Provider is active and can be used to create session.", + "x-example": "" + } + }, + "required": [ + "key", + "name", + "appId", + "secret", + "enabled" + ], + "example": { + "key": "github", + "name": "GitHub", + "appId": "259125845563242502", + "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ", + "enabled": "" + } + }, + "platformWeb": { + "description": "Platform Web", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "hostname": { + "type": "string", + "description": "Web app hostname. Empty string for other platforms.", + "x-example": "app.example.com" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "hostname", + "key" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "hostname": "app.example.com" + } + }, + "platformApple": { + "description": "Platform Apple", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "bundleIdentifier" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "bundleIdentifier": "com.company.appname" + } + }, + "platformAndroid": { + "description": "Platform Android", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "applicationId": { + "type": "string", + "description": "Android application ID.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "applicationId" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "applicationId": "com.company.appname" + } + }, + "platformWindows": { + "description": "Platform Windows", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "packageIdentifierName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "packageIdentifierName": "com.company.appname" + } + }, + "platformLinux": { + "description": "Platform Linux", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Platform ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Platform creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Platform update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Platform name.", + "x-example": "My Web App" + }, + "type": { + "type": "string", + "description": "Platform type. Possible values are: windows, apple, android, linux, web.", + "x-example": "web", + "enum": [ + "windows", + "apple", + "android", + "linux", + "web" + ] + }, + "packageName": { + "type": "string", + "description": "Linux package name.", + "x-example": "com.company.appname" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "type", + "packageName" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Web App", + "type": "web", + "packageName": "com.company.appname" + } + }, + "platformList": { + "description": "Platforms List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of platforms in the given project.", + "x-example": 5, + "format": "int32" + }, + "platforms": { + "type": "array", + "description": "List of platforms.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ] + }, + "x-example": "" + } + }, + "required": [ + "total", + "platforms" + ], + "example": { + "total": 5, + "platforms": "" + } + }, "variable": { "description": "Variable", "type": "object", @@ -57774,6 +61638,125 @@ "resourceType": "database" } }, + "billingLimits": { + "description": "BillingLimits", + "type": "object", + "properties": { + "bandwidth": { + "type": "integer", + "description": "Bandwidth limit", + "x-example": 5, + "format": "int32" + }, + "storage": { + "type": "integer", + "description": "Storage limit", + "x-example": 150, + "format": "int32" + }, + "users": { + "type": "integer", + "description": "Users limit", + "x-example": 200000, + "format": "int32" + }, + "executions": { + "type": "integer", + "description": "Executions limit", + "x-example": 750000, + "format": "int32" + }, + "GBHours": { + "type": "integer", + "description": "GBHours limit", + "x-example": 100, + "format": "int32" + }, + "imageTransformations": { + "type": "integer", + "description": "Image transformations limit", + "x-example": 100, + "format": "int32" + }, + "authPhone": { + "type": "integer", + "description": "Auth phone limit", + "x-example": 10, + "format": "int32" + }, + "budgetLimit": { + "type": "integer", + "description": "Budget limit percentage", + "x-example": 100, + "format": "int32" + } + }, + "required": [ + "bandwidth", + "storage", + "users", + "executions", + "GBHours", + "imageTransformations", + "authPhone", + "budgetLimit" + ], + "example": { + "bandwidth": 5, + "storage": 150, + "users": 200000, + "executions": 750000, + "GBHours": 100, + "imageTransformations": 100, + "authPhone": 10, + "budgetLimit": 100 + } + }, + "block": { + "description": "Block", + "type": "object", + "properties": { + "$createdAt": { + "type": "string", + "description": "Block creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "resourceType": { + "type": "string", + "description": "Resource type that is blocked", + "x-example": "project" + }, + "resourceId": { + "type": "string", + "description": "Resource identifier that is blocked", + "x-example": "5e5ea5c16897e" + }, + "reason": { + "type": "string", + "description": "Reason for the block. Can be null if no reason was provided.", + "x-example": "Payment overdue", + "x-nullable": true + }, + "expiredAt": { + "type": "string", + "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true + } + }, + "required": [ + "$createdAt", + "resourceType", + "resourceId" + ], + "example": { + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "resourceType": "project", + "resourceId": "5e5ea5c16897e", + "reason": "Payment overdue", + "expiredAt": "2020-10-15T06:38:00.000+00:00" + } + }, "backupPolicy": { "description": "backup", "type": "object",