diff --git a/app/config/specs/open-api3-1.7.x-client.json b/app/config/specs/open-api3-1.7.x-client.json index 1be340b5ec9..d11a6482223 100644 --- a/app/config/specs/open-api3-1.7.x-client.json +++ b/app/config/specs/open-api3-1.7.x-client.json @@ -18,6 +18,9 @@ "servers": [ { "url": "https:\/\/cloud.appwrite.io\/v1" + }, + { + "url": "https:\/\/.cloud.appwrite.io\/v1" } ], "paths": { @@ -43,6 +46,7 @@ }, "x-appwrite": { "method": "get", + "group": "account", "weight": 10, "cookies": false, "type": "", @@ -91,6 +95,7 @@ }, "x-appwrite": { "method": "create", + "group": "account", "weight": 9, "cookies": false, "type": "", @@ -175,6 +180,7 @@ }, "x-appwrite": { "method": "updateEmail", + "group": "account", "weight": 35, "cookies": false, "type": "", @@ -250,6 +256,7 @@ }, "x-appwrite": { "method": "listIdentities", + "group": "identities", "weight": 58, "cookies": false, "type": "", @@ -308,6 +315,7 @@ }, "x-appwrite": { "method": "deleteIdentity", + "group": "identities", "weight": 59, "cookies": false, "type": "", @@ -370,6 +378,7 @@ }, "x-appwrite": { "method": "createJWT", + "group": "tokens", "weight": 30, "cookies": false, "type": "", @@ -418,6 +427,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 32, "cookies": false, "type": "", @@ -483,6 +493,7 @@ }, "x-appwrite": { "method": "updateMFA", + "group": "mfa", "weight": 45, "cookies": false, "type": "", @@ -552,6 +563,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", + "group": "mfa", "weight": 47, "cookies": false, "type": "", @@ -597,7 +609,7 @@ ] }, "put": { - "summary": "Verify authenticator", + "summary": "Update authenticator (confirmation)", "operationId": "accountUpdateMfaAuthenticator", "tags": [ "account" @@ -617,6 +629,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", + "group": "mfa", "weight": 48, "cookies": false, "type": "", @@ -694,6 +707,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", + "group": "mfa", "weight": 52, "cookies": false, "type": "", @@ -761,6 +775,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", + "group": "mfa", "weight": 53, "cookies": false, "type": "", @@ -814,7 +829,7 @@ } }, "put": { - "summary": "Create MFA challenge (confirmation)", + "summary": "Update MFA challenge (confirmation)", "operationId": "accountUpdateMfaChallenge", "tags": [ "account" @@ -834,6 +849,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", + "group": "mfa", "weight": 54, "cookies": false, "type": "", @@ -909,6 +925,7 @@ }, "x-appwrite": { "method": "listMfaFactors", + "group": "mfa", "weight": 46, "cookies": false, "type": "", @@ -939,7 +956,7 @@ }, "\/account\/mfa\/recovery-codes": { "get": { - "summary": "Get MFA recovery codes", + "summary": "List MFA recovery codes", "operationId": "accountGetMfaRecoveryCodes", "tags": [ "account" @@ -959,6 +976,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", + "group": "mfa", "weight": 51, "cookies": false, "type": "", @@ -1007,6 +1025,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", + "group": "mfa", "weight": 49, "cookies": false, "type": "", @@ -1035,7 +1054,7 @@ ] }, "patch": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "accountUpdateMfaRecoveryCodes", "tags": [ "account" @@ -1055,6 +1074,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", + "group": "mfa", "weight": 50, "cookies": false, "type": "", @@ -1105,6 +1125,7 @@ }, "x-appwrite": { "method": "updateName", + "group": "account", "weight": 33, "cookies": false, "type": "", @@ -1174,6 +1195,7 @@ }, "x-appwrite": { "method": "updatePassword", + "group": "account", "weight": 34, "cookies": false, "type": "", @@ -1248,6 +1270,7 @@ }, "x-appwrite": { "method": "updatePhone", + "group": "account", "weight": 36, "cookies": false, "type": "", @@ -1323,6 +1346,7 @@ }, "x-appwrite": { "method": "getPrefs", + "group": "account", "weight": 31, "cookies": false, "type": "", @@ -1371,6 +1395,7 @@ }, "x-appwrite": { "method": "updatePrefs", + "group": "account", "weight": 37, "cookies": false, "type": "", @@ -1440,6 +1465,7 @@ }, "x-appwrite": { "method": "createRecovery", + "group": "recovery", "weight": 39, "cookies": false, "type": "", @@ -1496,7 +1522,7 @@ } }, "put": { - "summary": "Create password recovery (confirmation)", + "summary": "Update password recovery (confirmation)", "operationId": "accountUpdateRecovery", "tags": [ "account" @@ -1516,6 +1542,7 @@ }, "x-appwrite": { "method": "updateRecovery", + "group": "recovery", "weight": 40, "cookies": false, "type": "", @@ -1597,6 +1624,7 @@ }, "x-appwrite": { "method": "listSessions", + "group": "sessions", "weight": 12, "cookies": false, "type": "", @@ -1638,6 +1666,7 @@ }, "x-appwrite": { "method": "deleteSessions", + "group": "sessions", "weight": 13, "cookies": false, "type": "", @@ -1688,6 +1717,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", + "group": "sessions", "weight": 18, "cookies": false, "type": "", @@ -1736,6 +1766,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", + "group": "sessions", "weight": 17, "cookies": false, "type": "", @@ -1809,6 +1840,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", + "group": "sessions", "weight": 27, "cookies": false, "type": "", @@ -1875,6 +1907,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", + "group": "sessions", "weight": 20, "cookies": false, "type": "webAuth", @@ -1902,7 +1935,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -1922,6 +1955,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2015,6 +2049,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", + "group": "sessions", "weight": 28, "cookies": false, "type": "", @@ -2088,6 +2123,7 @@ }, "x-appwrite": { "method": "createSession", + "group": "sessions", "weight": 19, "cookies": false, "type": "", @@ -2161,6 +2197,7 @@ }, "x-appwrite": { "method": "getSession", + "group": "sessions", "weight": 14, "cookies": false, "type": "", @@ -2221,6 +2258,7 @@ }, "x-appwrite": { "method": "updateSession", + "group": "sessions", "weight": 16, "cookies": false, "type": "", @@ -2274,6 +2312,7 @@ }, "x-appwrite": { "method": "deleteSession", + "group": "sessions", "weight": 15, "cookies": false, "type": "", @@ -2336,6 +2375,7 @@ }, "x-appwrite": { "method": "updateStatus", + "group": "account", "weight": 38, "cookies": false, "type": "", @@ -2386,6 +2426,7 @@ }, "x-appwrite": { "method": "createPushTarget", + "group": "pushTargets", "weight": 55, "cookies": false, "type": "", @@ -2464,6 +2505,7 @@ }, "x-appwrite": { "method": "updatePushTarget", + "group": "pushTargets", "weight": 56, "cookies": false, "type": "", @@ -2534,6 +2576,7 @@ }, "x-appwrite": { "method": "deletePushTarget", + "group": "pushTargets", "weight": 57, "cookies": false, "type": "", @@ -2594,6 +2637,7 @@ }, "x-appwrite": { "method": "createEmailToken", + "group": "tokens", "weight": 26, "cookies": false, "type": "", @@ -2602,7 +2646,10 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md", "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},email:{param-email}", + "rate-key": [ + "url:{url},email:{param-email}", + "url:{url},ip:{ip}" + ], "scope": "sessions.write", "platforms": [ "server", @@ -2672,6 +2719,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", + "group": "tokens", "weight": 25, "cookies": false, "type": "", @@ -2751,6 +2799,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", + "group": "tokens", "weight": 24, "cookies": false, "type": "webAuth", @@ -2778,7 +2827,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -2798,6 +2847,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2891,6 +2941,7 @@ }, "x-appwrite": { "method": "createPhoneToken", + "group": "tokens", "weight": 29, "cookies": false, "type": "", @@ -2967,6 +3018,7 @@ }, "x-appwrite": { "method": "createVerification", + "group": "verification", "weight": 41, "cookies": false, "type": "", @@ -3014,7 +3066,7 @@ } }, "put": { - "summary": "Create email verification (confirmation)", + "summary": "Update email verification (confirmation)", "operationId": "accountUpdateVerification", "tags": [ "account" @@ -3034,6 +3086,7 @@ }, "x-appwrite": { "method": "updateVerification", + "group": "verification", "weight": 42, "cookies": false, "type": "", @@ -3109,6 +3162,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", + "group": "verification", "weight": 43, "cookies": false, "type": "", @@ -3160,6 +3214,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", + "group": "verification", "weight": 44, "cookies": false, "type": "", @@ -3228,6 +3283,7 @@ }, "x-appwrite": { "method": "getBrowser", + "group": null, "weight": 61, "cookies": false, "type": "location", @@ -3325,13 +3381,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -3353,6 +3409,7 @@ }, "x-appwrite": { "method": "getCreditCard", + "group": null, "weight": 60, "cookies": false, "type": "location", @@ -3456,13 +3513,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -3484,6 +3541,7 @@ }, "x-appwrite": { "method": "getFavicon", + "group": null, "weight": 64, "cookies": false, "type": "location", @@ -3541,6 +3599,7 @@ }, "x-appwrite": { "method": "getFlag", + "group": null, "weight": 62, "cookies": false, "type": "location", @@ -4000,13 +4059,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -4028,6 +4087,7 @@ }, "x-appwrite": { "method": "getImage", + "group": null, "weight": 63, "cookies": false, "type": "location", @@ -4109,6 +4169,7 @@ }, "x-appwrite": { "method": "getInitials", + "group": null, "weight": 66, "cookies": false, "type": "location", @@ -4200,6 +4261,7 @@ }, "x-appwrite": { "method": "getQR", + "group": null, "weight": 65, "cookies": false, "type": "location", @@ -4298,6 +4360,7 @@ }, "x-appwrite": { "method": "listDocuments", + "group": "documents", "weight": 110, "cookies": false, "type": "", @@ -4367,7 +4430,7 @@ "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -4382,6 +4445,7 @@ }, "x-appwrite": { "method": "createDocument", + "group": "documents", "weight": 109, "cookies": false, "type": "", @@ -4398,6 +4462,59 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -4454,12 +4571,16 @@ "items": { "type": "string" } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } } - }, - "required": [ - "documentId", - "data" - ] + } } } } @@ -4488,6 +4609,7 @@ }, "x-appwrite": { "method": "getDocument", + "group": "documents", "weight": 111, "cookies": false, "type": "", @@ -4582,6 +4704,7 @@ }, "x-appwrite": { "method": "updateDocument", + "group": "documents", "weight": 113, "cookies": false, "type": "", @@ -4680,7 +4803,8 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 114, + "group": "documents", + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -4763,7 +4887,8 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 384, + "group": "executions", + "weight": 391, "cookies": false, "type": "", "deprecated": false, @@ -4837,7 +4962,8 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 382, + "group": "executions", + "weight": 389, "cookies": false, "type": "", "deprecated": false, @@ -4951,7 +5077,8 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 383, + "group": "executions", + "weight": 390, "cookies": false, "type": "", "deprecated": false, @@ -5024,7 +5151,8 @@ }, "x-appwrite": { "method": "query", - "weight": 303, + "group": "graphql", + "weight": 305, "cookies": false, "type": "graphql", "deprecated": false, @@ -5075,7 +5203,8 @@ }, "x-appwrite": { "method": "mutation", - "weight": 302, + "group": "graphql", + "weight": 304, "cookies": false, "type": "graphql", "deprecated": false, @@ -5126,7 +5255,8 @@ }, "x-appwrite": { "method": "get", - "weight": 118, + "group": null, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -5177,7 +5307,8 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 119, + "group": null, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -5228,7 +5359,8 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 123, + "group": null, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -5279,7 +5411,8 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 120, + "group": null, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -5330,7 +5463,8 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 121, + "group": null, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -5381,7 +5515,8 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 122, + "group": null, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -5432,7 +5567,8 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 124, + "group": null, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -5483,7 +5619,8 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 125, + "group": null, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -5534,7 +5671,8 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 349, + "group": "subscribers", + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5616,7 +5754,8 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 353, + "group": "subscribers", + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -5690,7 +5829,8 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 209, + "group": "files", + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -5775,7 +5915,8 @@ }, "x-appwrite": { "method": "createFile", - "weight": 208, + "group": "files", + "weight": 210, "cookies": false, "type": "upload", "deprecated": false, @@ -5872,7 +6013,8 @@ }, "x-appwrite": { "method": "getFile", - "weight": 210, + "group": "files", + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -5943,7 +6085,8 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 215, + "group": "files", + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -6031,7 +6174,8 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 216, + "group": "files", + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -6097,7 +6241,8 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 212, + "group": "files", + "weight": 214, "cookies": false, "type": "location", "deprecated": false, @@ -6144,6 +6289,17 @@ "x-example": "" }, "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -6163,7 +6319,8 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 211, + "group": "files", + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -6261,13 +6418,13 @@ }, { "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" }, @@ -6360,6 +6517,17 @@ "default": "" }, "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -6379,7 +6547,8 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 213, + "group": "files", + "weight": 215, "cookies": false, "type": "location", "deprecated": false, @@ -6426,6 +6595,17 @@ "x-example": "" }, "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -6452,7 +6632,8 @@ }, "x-appwrite": { "method": "list", - "weight": 220, + "group": "teams", + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -6527,7 +6708,8 @@ }, "x-appwrite": { "method": "create", - "weight": 219, + "group": "teams", + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -6611,7 +6793,8 @@ }, "x-appwrite": { "method": "get", - "weight": 221, + "group": "teams", + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -6672,7 +6855,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 223, + "group": "teams", + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -6745,7 +6929,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 225, + "group": "teams", + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -6808,7 +6993,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 227, + "group": "memberships", + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -6893,7 +7079,8 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 226, + "group": "memberships", + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -7003,7 +7190,8 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 228, + "group": "memberships", + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -7074,7 +7262,8 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 229, + "group": "memberships", + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -7160,7 +7349,8 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 231, + "group": "memberships", + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -7233,7 +7423,8 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 230, + "group": "memberships", + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -7330,7 +7521,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 222, + "group": "teams", + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -7390,7 +7582,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 224, + "group": "teams", + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -7448,598 +7641,134 @@ } } } + } + }, + "tags": [ + { + "name": "account", + "description": "The Account service allows you to authenticate and manage a user account." }, - "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "List tokens", - "operationId": "tokensList", - "tags": [ - "tokens" - ], - "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Resource Tokens List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/resourceTokenList" - } - } - } + { + "name": "avatars", + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." + }, + { + "name": "databases", + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" + }, + { + "name": "locale", + "description": "The Locale service allows you to customize your app based on your users' location." + }, + { + "name": "health", + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." + }, + { + "name": "projects", + "description": "The Project service allows you to manage all the projects in your Appwrite server." + }, + { + "name": "project", + "description": "The Project service allows you to manage all the projects in your Appwrite server." + }, + { + "name": "storage", + "description": "The Storage service allows you to manage your project files." + }, + { + "name": "teams", + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" + }, + { + "name": "users", + "description": "The Users service allows you to manage your project users." + }, + { + "name": "sites", + "description": "The Sites Service allows you view, create and manage your web applications." + }, + { + "name": "functions", + "description": "The Functions Service allows you view, create and manage your Cloud Functions." + }, + { + "name": "proxy", + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." + }, + { + "name": "graphql", + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." + }, + { + "name": "console", + "description": "The Console service allows you to interact with console relevant informations." + }, + { + "name": "migrations", + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." + }, + { + "name": "messaging", + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." + } + ], + "components": { + "schemas": { + "any": { + "description": "Any", + "type": "object", + "additionalProperties": true + }, + "error": { + "description": "Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Error message.", + "x-example": "Not found" + }, + "code": { + "type": "string", + "description": "Error code.", + "x-example": "404" + }, + "type": { + "type": "string", + "description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes", + "x-example": "not_found" + }, + "version": { + "type": "string", + "description": "Server version number.", + "x-example": "1.0" } }, - "x-appwrite": { - "method": "list", - "weight": 432, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/list.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList all the tokens created for a specific file or bucket. You can use the query params to filter your results.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire", - "required": false, - "schema": { - "type": "string", - "default": [] - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create file token", - "operationId": "tokensCreateFileToken", - "tags": [ - "tokens" - ], - "description": "Create a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", - "responses": { - "201": { - "description": "ResourceToken", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/resourceToken" - } - } - } - } - }, - "x-appwrite": { - "method": "createFileToken", - "weight": 429, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/create-file-token.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "expire": { - "type": "string", - "description": "Token expiry date", - "x-example": null, - "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "\/tokens\/{tokenId}": { - "get": { - "summary": "Get token", - "operationId": "tokensGet", - "tags": [ - "tokens" - ], - "description": "Get a token by its unique ID.", - "responses": { - "200": { - "description": "ResourceToken", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/resourceToken" - } - } - } - } - }, - "x-appwrite": { - "method": "get", - "weight": 430, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a token by its unique ID.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "Token ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "patch": { - "summary": "Update token", - "operationId": "tokensUpdate", - "tags": [ - "tokens" - ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", - "responses": { - "200": { - "description": "ResourceToken", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/resourceToken" - } - } - } - } - }, - "x-appwrite": { - "method": "update", - "weight": 433, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/update.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "Token unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "expire": { - "type": "string", - "description": "File token expiry date", - "x-example": null, - "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete token", - "operationId": "tokensDelete", - "tags": [ - "tokens" - ], - "description": "Delete a token by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "x-appwrite": { - "method": "delete", - "weight": 434, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/delete.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a token by its unique ID.", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "Token ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/tokens\/{tokenId}\/jwt": { - "get": { - "summary": "Get token as JWT", - "operationId": "tokensGetJWT", - "tags": [ - "tokens" - ], - "description": "Get a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "responses": { - "200": { - "description": "JWT", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/jwt" - } - } - } - } - }, - "x-appwrite": { - "method": "getJWT", - "weight": 431, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get-j-w-t.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "File token ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - } - }, - "tags": [ - { - "name": "account", - "description": "The Account service allows you to authenticate and manage a user account.", - "x-globalAttributes": [] - }, - { - "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.", - "x-globalAttributes": [] - }, - { - "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents", - "x-globalAttributes": [ - "databaseId" - ] - }, - { - "name": "locale", - "description": "The Locale service allows you to customize your app based on your users' location.", - "x-globalAttributes": [] - }, - { - "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health.", - "x-globalAttributes": [] - }, - { - "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] - }, - { - "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] - }, - { - "name": "storage", - "description": "The Storage service allows you to manage your project files.", - "x-globalAttributes": [] - }, - { - "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources", - "x-globalAttributes": [] - }, - { - "name": "users", - "description": "The Users service allows you to manage your project users.", - "x-globalAttributes": [] - }, - { - "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications.", - "x-globalAttributes": [] - }, - { - "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions.", - "x-globalAttributes": [] - }, - { - "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration.", - "x-globalAttributes": [] - }, - { - "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.", - "x-globalAttributes": [] - }, - { - "name": "console", - "description": "The Console service allows you to interact with console relevant informations.", - "x-globalAttributes": [] - }, - { - "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project.", - "x-globalAttributes": [] - }, - { - "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).", - "x-globalAttributes": [] - } - ], - "components": { - "schemas": { - "any": { - "description": "Any", - "type": "object", - "additionalProperties": true - }, - "error": { - "description": "Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Error message.", - "x-example": "Not found" - }, - "code": { - "type": "string", - "description": "Error code.", - "x-example": "404" - }, - "type": { - "type": "string", - "description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes", - "x-example": "not_found" - }, - "version": { - "type": "string", - "description": "Server version number.", - "x-example": "1.0" - } - }, - "required": [ - "message", - "code", - "type", - "version" - ] - }, - "documentList": { - "description": "Documents List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of documents documents that matched your query.", - "x-example": 5, - "format": "int32" - }, - "documents": { - "type": "array", - "description": "List of documents.", - "items": { - "$ref": "#\/components\/schemas\/document" - }, - "x-example": "" + "required": [ + "message", + "code", + "type", + "version" + ] + }, + "documentList": { + "description": "Documents List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of documents documents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "documents": { + "type": "array", + "description": "List of documents.", + "items": { + "$ref": "#\/components\/schemas\/document" + }, + "x-example": "" } }, "required": [ @@ -8143,30 +7872,6 @@ "files" ] }, - "resourceTokenList": { - "description": "Resource Tokens List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of tokens documents that matched your query.", - "x-example": 5, - "format": "int32" - }, - "tokens": { - "type": "array", - "description": "List of tokens.", - "items": { - "$ref": "#\/components\/schemas\/resourceToken" - }, - "x-example": "" - } - }, - "required": [ - "total", - "tokens" - ] - }, "teamList": { "description": "Teams List", "type": "object", @@ -9363,50 +9068,6 @@ "chunksUploaded" ] }, - "resourceToken": { - "description": "ResourceToken", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "resourceId": { - "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" - }, - "resourceInternalId": { - "type": "string", - "description": "File ID.", - "x-example": "1:1" - }, - "resourceType": { - "type": "string", - "description": "Resource type.", - "x-example": "file" - }, - "expire": { - "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - } - }, - "required": [ - "$id", - "$createdAt", - "resourceId", - "resourceInternalId", - "resourceType", - "expire" - ] - }, "team": { "description": "Team", "type": "object", diff --git a/app/config/specs/open-api3-1.7.x-console.json b/app/config/specs/open-api3-1.7.x-console.json index 6c999d047af..5e1d6f345d8 100644 --- a/app/config/specs/open-api3-1.7.x-console.json +++ b/app/config/specs/open-api3-1.7.x-console.json @@ -18,6 +18,9 @@ "servers": [ { "url": "https:\/\/cloud.appwrite.io\/v1" + }, + { + "url": "https:\/\/.cloud.appwrite.io\/v1" } ], "paths": { @@ -43,6 +46,7 @@ }, "x-appwrite": { "method": "get", + "group": "account", "weight": 10, "cookies": false, "type": "", @@ -90,6 +94,7 @@ }, "x-appwrite": { "method": "create", + "group": "account", "weight": 9, "cookies": false, "type": "", @@ -165,6 +170,7 @@ }, "x-appwrite": { "method": "delete", + "group": "account", "weight": 11, "cookies": false, "type": "", @@ -212,6 +218,7 @@ }, "x-appwrite": { "method": "updateEmail", + "group": "account", "weight": 35, "cookies": false, "type": "", @@ -286,6 +293,7 @@ }, "x-appwrite": { "method": "listIdentities", + "group": "identities", "weight": 58, "cookies": false, "type": "", @@ -343,6 +351,7 @@ }, "x-appwrite": { "method": "deleteIdentity", + "group": "identities", "weight": 59, "cookies": false, "type": "", @@ -404,6 +413,7 @@ }, "x-appwrite": { "method": "createJWT", + "group": "tokens", "weight": 30, "cookies": false, "type": "", @@ -452,6 +462,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 32, "cookies": false, "type": "", @@ -516,6 +527,7 @@ }, "x-appwrite": { "method": "updateMFA", + "group": "mfa", "weight": 45, "cookies": false, "type": "", @@ -584,6 +596,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", + "group": "mfa", "weight": 47, "cookies": false, "type": "", @@ -628,7 +641,7 @@ ] }, "put": { - "summary": "Verify authenticator", + "summary": "Update authenticator (confirmation)", "operationId": "accountUpdateMfaAuthenticator", "tags": [ "account" @@ -648,6 +661,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", + "group": "mfa", "weight": 48, "cookies": false, "type": "", @@ -724,6 +738,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", + "group": "mfa", "weight": 52, "cookies": false, "type": "", @@ -790,6 +805,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", + "group": "mfa", "weight": 53, "cookies": false, "type": "", @@ -843,7 +859,7 @@ } }, "put": { - "summary": "Create MFA challenge (confirmation)", + "summary": "Update MFA challenge (confirmation)", "operationId": "accountUpdateMfaChallenge", "tags": [ "account" @@ -863,6 +879,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", + "group": "mfa", "weight": 54, "cookies": false, "type": "", @@ -937,6 +954,7 @@ }, "x-appwrite": { "method": "listMfaFactors", + "group": "mfa", "weight": 46, "cookies": false, "type": "", @@ -966,7 +984,7 @@ }, "\/account\/mfa\/recovery-codes": { "get": { - "summary": "Get MFA recovery codes", + "summary": "List MFA recovery codes", "operationId": "accountGetMfaRecoveryCodes", "tags": [ "account" @@ -986,6 +1004,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", + "group": "mfa", "weight": 51, "cookies": false, "type": "", @@ -1033,6 +1052,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", + "group": "mfa", "weight": 49, "cookies": false, "type": "", @@ -1060,7 +1080,7 @@ ] }, "patch": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "accountUpdateMfaRecoveryCodes", "tags": [ "account" @@ -1080,6 +1100,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", + "group": "mfa", "weight": 50, "cookies": false, "type": "", @@ -1129,6 +1150,7 @@ }, "x-appwrite": { "method": "updateName", + "group": "account", "weight": 33, "cookies": false, "type": "", @@ -1197,6 +1219,7 @@ }, "x-appwrite": { "method": "updatePassword", + "group": "account", "weight": 34, "cookies": false, "type": "", @@ -1270,6 +1293,7 @@ }, "x-appwrite": { "method": "updatePhone", + "group": "account", "weight": 36, "cookies": false, "type": "", @@ -1344,6 +1368,7 @@ }, "x-appwrite": { "method": "getPrefs", + "group": "account", "weight": 31, "cookies": false, "type": "", @@ -1391,6 +1416,7 @@ }, "x-appwrite": { "method": "updatePrefs", + "group": "account", "weight": 37, "cookies": false, "type": "", @@ -1459,6 +1485,7 @@ }, "x-appwrite": { "method": "createRecovery", + "group": "recovery", "weight": 39, "cookies": false, "type": "", @@ -1514,7 +1541,7 @@ } }, "put": { - "summary": "Create password recovery (confirmation)", + "summary": "Update password recovery (confirmation)", "operationId": "accountUpdateRecovery", "tags": [ "account" @@ -1534,6 +1561,7 @@ }, "x-appwrite": { "method": "updateRecovery", + "group": "recovery", "weight": 40, "cookies": false, "type": "", @@ -1614,6 +1642,7 @@ }, "x-appwrite": { "method": "listSessions", + "group": "sessions", "weight": 12, "cookies": false, "type": "", @@ -1654,6 +1683,7 @@ }, "x-appwrite": { "method": "deleteSessions", + "group": "sessions", "weight": 13, "cookies": false, "type": "", @@ -1703,6 +1733,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", + "group": "sessions", "weight": 18, "cookies": false, "type": "", @@ -1751,6 +1782,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", + "group": "sessions", "weight": 17, "cookies": false, "type": "", @@ -1824,6 +1856,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", + "group": "sessions", "weight": 27, "cookies": false, "type": "", @@ -1890,6 +1923,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", + "group": "sessions", "weight": 20, "cookies": false, "type": "webAuth", @@ -1917,7 +1951,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -1937,6 +1971,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2030,6 +2065,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", + "group": "sessions", "weight": 28, "cookies": false, "type": "", @@ -2103,6 +2139,7 @@ }, "x-appwrite": { "method": "createSession", + "group": "sessions", "weight": 19, "cookies": false, "type": "", @@ -2176,6 +2213,7 @@ }, "x-appwrite": { "method": "getSession", + "group": "sessions", "weight": 14, "cookies": false, "type": "", @@ -2235,6 +2273,7 @@ }, "x-appwrite": { "method": "updateSession", + "group": "sessions", "weight": 16, "cookies": false, "type": "", @@ -2287,6 +2326,7 @@ }, "x-appwrite": { "method": "deleteSession", + "group": "sessions", "weight": 15, "cookies": false, "type": "", @@ -2348,6 +2388,7 @@ }, "x-appwrite": { "method": "updateStatus", + "group": "account", "weight": 38, "cookies": false, "type": "", @@ -2397,6 +2438,7 @@ }, "x-appwrite": { "method": "createPushTarget", + "group": "pushTargets", "weight": 55, "cookies": false, "type": "", @@ -2474,6 +2516,7 @@ }, "x-appwrite": { "method": "updatePushTarget", + "group": "pushTargets", "weight": 56, "cookies": false, "type": "", @@ -2543,6 +2586,7 @@ }, "x-appwrite": { "method": "deletePushTarget", + "group": "pushTargets", "weight": 57, "cookies": false, "type": "", @@ -2602,6 +2646,7 @@ }, "x-appwrite": { "method": "createEmailToken", + "group": "tokens", "weight": 26, "cookies": false, "type": "", @@ -2610,7 +2655,10 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md", "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},email:{param-email}", + "rate-key": [ + "url:{url},email:{param-email}", + "url:{url},ip:{ip}" + ], "scope": "sessions.write", "platforms": [ "server", @@ -2680,6 +2728,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", + "group": "tokens", "weight": 25, "cookies": false, "type": "", @@ -2759,6 +2808,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", + "group": "tokens", "weight": 24, "cookies": false, "type": "webAuth", @@ -2786,7 +2836,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -2806,6 +2856,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2899,6 +2950,7 @@ }, "x-appwrite": { "method": "createPhoneToken", + "group": "tokens", "weight": 29, "cookies": false, "type": "", @@ -2975,6 +3027,7 @@ }, "x-appwrite": { "method": "createVerification", + "group": "verification", "weight": 41, "cookies": false, "type": "", @@ -3021,7 +3074,7 @@ } }, "put": { - "summary": "Create email verification (confirmation)", + "summary": "Update email verification (confirmation)", "operationId": "accountUpdateVerification", "tags": [ "account" @@ -3041,6 +3094,7 @@ }, "x-appwrite": { "method": "updateVerification", + "group": "verification", "weight": 42, "cookies": false, "type": "", @@ -3115,6 +3169,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", + "group": "verification", "weight": 43, "cookies": false, "type": "", @@ -3165,6 +3220,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", + "group": "verification", "weight": 44, "cookies": false, "type": "", @@ -3232,6 +3288,7 @@ }, "x-appwrite": { "method": "getBrowser", + "group": null, "weight": 61, "cookies": false, "type": "location", @@ -3329,13 +3386,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -3357,6 +3414,7 @@ }, "x-appwrite": { "method": "getCreditCard", + "group": null, "weight": 60, "cookies": false, "type": "location", @@ -3460,13 +3518,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -3488,6 +3546,7 @@ }, "x-appwrite": { "method": "getFavicon", + "group": null, "weight": 64, "cookies": false, "type": "location", @@ -3545,6 +3604,7 @@ }, "x-appwrite": { "method": "getFlag", + "group": null, "weight": 62, "cookies": false, "type": "location", @@ -4004,13 +4064,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -4032,6 +4092,7 @@ }, "x-appwrite": { "method": "getImage", + "group": null, "weight": 63, "cookies": false, "type": "location", @@ -4113,6 +4174,7 @@ }, "x-appwrite": { "method": "getInitials", + "group": null, "weight": 66, "cookies": false, "type": "location", @@ -4204,6 +4266,7 @@ }, "x-appwrite": { "method": "getQR", + "group": null, "weight": 65, "cookies": false, "type": "location", @@ -4282,7 +4345,7 @@ }, "\/console\/assistant": { "post": { - "summary": "Ask query", + "summary": "Create assistant query", "operationId": "assistantChat", "tags": [ "assistant" @@ -4295,7 +4358,8 @@ }, "x-appwrite": { "method": "chat", - "weight": 305, + "group": "console", + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -4354,7 +4418,8 @@ }, "x-appwrite": { "method": "getResource", - "weight": 424, + "group": null, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -4428,7 +4493,8 @@ }, "x-appwrite": { "method": "variables", - "weight": 304, + "group": "console", + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -4475,6 +4541,7 @@ }, "x-appwrite": { "method": "list", + "group": "databases", "weight": 71, "cookies": false, "type": "", @@ -4547,6 +4614,7 @@ }, "x-appwrite": { "method": "create", + "group": "databases", "weight": 70, "cookies": false, "type": "", @@ -4625,7 +4693,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 115, + "group": null, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -4696,6 +4765,7 @@ }, "x-appwrite": { "method": "get", + "group": "databases", "weight": 72, "cookies": false, "type": "", @@ -4754,6 +4824,7 @@ }, "x-appwrite": { "method": "update", + "group": "databases", "weight": 74, "cookies": false, "type": "", @@ -4829,6 +4900,7 @@ }, "x-appwrite": { "method": "delete", + "group": "databases", "weight": 75, "cookies": false, "type": "", @@ -4889,6 +4961,7 @@ }, "x-appwrite": { "method": "listCollections", + "group": "collections", "weight": 77, "cookies": false, "type": "", @@ -4971,6 +5044,7 @@ }, "x-appwrite": { "method": "createCollection", + "group": "collections", "weight": 76, "cookies": false, "type": "", @@ -5074,6 +5148,7 @@ }, "x-appwrite": { "method": "getCollection", + "group": "collections", "weight": 78, "cookies": false, "type": "", @@ -5142,6 +5217,7 @@ }, "x-appwrite": { "method": "updateCollection", + "group": "collections", "weight": 80, "cookies": false, "type": "", @@ -5240,6 +5316,7 @@ }, "x-appwrite": { "method": "deleteCollection", + "group": "collections", "weight": 81, "cookies": false, "type": "", @@ -5310,6 +5387,7 @@ }, "x-appwrite": { "method": "listAttributes", + "group": "attributes", "weight": 92, "cookies": false, "type": "", @@ -5393,6 +5471,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", + "group": "attributes", "weight": 89, "cookies": false, "type": "", @@ -5498,6 +5577,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", + "group": "attributes", "weight": 101, "cookies": false, "type": "", @@ -5608,6 +5688,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", + "group": "attributes", "weight": 90, "cookies": false, "type": "", @@ -5713,6 +5794,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", + "group": "attributes", "weight": 102, "cookies": false, "type": "", @@ -5823,6 +5905,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", + "group": "attributes", "weight": 83, "cookies": false, "type": "", @@ -5928,6 +6011,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", + "group": "attributes", "weight": 95, "cookies": false, "type": "", @@ -6038,6 +6122,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", + "group": "attributes", "weight": 84, "cookies": false, "type": "", @@ -6152,6 +6237,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", + "group": "attributes", "weight": 96, "cookies": false, "type": "", @@ -6271,6 +6357,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", + "group": "attributes", "weight": 88, "cookies": false, "type": "", @@ -6386,6 +6473,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", + "group": "attributes", "weight": 100, "cookies": false, "type": "", @@ -6506,6 +6594,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", + "group": "attributes", "weight": 87, "cookies": false, "type": "", @@ -6621,6 +6710,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", + "group": "attributes", "weight": 99, "cookies": false, "type": "", @@ -6741,6 +6831,7 @@ }, "x-appwrite": { "method": "createIpAttribute", + "group": "attributes", "weight": 85, "cookies": false, "type": "", @@ -6846,6 +6937,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", + "group": "attributes", "weight": 97, "cookies": false, "type": "", @@ -6956,6 +7048,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", + "group": "attributes", "weight": 91, "cookies": false, "type": "", @@ -7086,6 +7179,7 @@ }, "x-appwrite": { "method": "createStringAttribute", + "group": "attributes", "weight": 82, "cookies": false, "type": "", @@ -7202,6 +7296,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", + "group": "attributes", "weight": 94, "cookies": false, "type": "", @@ -7317,6 +7412,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", + "group": "attributes", "weight": 86, "cookies": false, "type": "", @@ -7422,6 +7518,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", + "group": "attributes", "weight": 98, "cookies": false, "type": "", @@ -7563,6 +7660,7 @@ }, "x-appwrite": { "method": "getAttribute", + "group": "attributes", "weight": 93, "cookies": false, "type": "", @@ -7633,6 +7731,7 @@ }, "x-appwrite": { "method": "deleteAttribute", + "group": "attributes", "weight": 104, "cookies": false, "type": "", @@ -7712,6 +7811,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", + "group": "attributes", "weight": 103, "cookies": false, "type": "", @@ -7819,6 +7919,7 @@ }, "x-appwrite": { "method": "listDocuments", + "group": "documents", "weight": 110, "cookies": false, "type": "", @@ -7888,7 +7989,7 @@ "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -7903,6 +8004,7 @@ }, "x-appwrite": { "method": "createDocument", + "group": "documents", "weight": 109, "cookies": false, "type": "", @@ -7919,6 +8021,59 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -7975,53 +8130,54 @@ "items": { "type": "string" } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } } - }, - "required": [ - "documentId", - "data" - ] + } } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + }, + "put": { + "summary": "Create or update documents", + "operationId": "databasesUpsertDocuments", "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { "200": { - "description": "Document", + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/documentList" } } } } }, "x-appwrite": { - "method": "getDocument", - "weight": 111, + "method": "upsertDocuments", + "group": "documents", + "weight": 115, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, @@ -8032,8 +8188,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8049,73 +8204,68 @@ }, { "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", "x-example": "" }, "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + } + } }, "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", "responses": { "200": { - "description": "Document", + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/documentList" } } } } }, "x-appwrite": { - "method": "updateDocument", - "weight": 113, + "method": "updateDocuments", + "group": "documents", + "weight": 114, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/update-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "demo": "databases\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, @@ -8126,8 +8276,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -8150,16 +8299,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -8173,10 +8312,10 @@ "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", "x-example": "{}" }, - "permissions": { + "queries": { "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, "items": { "type": "string" } @@ -8188,25 +8327,317 @@ } }, "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", "tags": [ "databases" ], - "description": "Delete a document by its unique ID.", + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } } }, "x-appwrite": { - "method": "deleteDocument", - "weight": 114, + "method": "deleteDocuments", + "group": "documents", + "weight": 117, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/delete-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "demo": "databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "databasesGetDocument", + "tags": [ + "databases" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 111, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", + "tags": [ + "databases" + ], + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 113, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete document", + "operationId": "databasesDeleteDocument", + "tags": [ + "databases" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 116, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", @@ -8284,6 +8715,7 @@ }, "x-appwrite": { "method": "listDocumentLogs", + "group": "logs", "weight": 112, "cookies": false, "type": "", @@ -8376,6 +8808,7 @@ }, "x-appwrite": { "method": "listIndexes", + "group": "indexes", "weight": 106, "cookies": false, "type": "", @@ -8457,6 +8890,7 @@ }, "x-appwrite": { "method": "createIndex", + "group": "collections", "weight": 105, "cookies": false, "type": "", @@ -8541,6 +8975,14 @@ "items": { "type": "string" } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } } }, "required": [ @@ -8576,6 +9018,7 @@ }, "x-appwrite": { "method": "getIndex", + "group": "indexes", "weight": 107, "cookies": false, "type": "", @@ -8646,6 +9089,7 @@ }, "x-appwrite": { "method": "deleteIndex", + "group": "indexes", "weight": 108, "cookies": false, "type": "", @@ -8725,6 +9169,7 @@ }, "x-appwrite": { "method": "listCollectionLogs", + "group": "collections", "weight": 79, "cookies": false, "type": "", @@ -8807,7 +9252,8 @@ }, "x-appwrite": { "method": "getCollectionUsage", - "weight": 117, + "group": null, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -8898,6 +9344,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 73, "cookies": false, "type": "", @@ -8970,7 +9417,8 @@ }, "x-appwrite": { "method": "getDatabaseUsage", - "weight": 116, + "group": null, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -9051,7 +9499,8 @@ }, "x-appwrite": { "method": "list", - "weight": 368, + "group": "functions", + "weight": 375, "cookies": false, "type": "", "deprecated": false, @@ -9123,7 +9572,8 @@ }, "x-appwrite": { "method": "create", - "weight": 365, + "group": "functions", + "weight": 372, "cookies": false, "type": "", "deprecated": false, @@ -9353,7 +9803,8 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 370, + "group": "runtimes", + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -9401,7 +9852,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 371, + "group": "runtimes", + "weight": 378, "cookies": false, "type": "", "deprecated": false, @@ -9450,7 +9902,8 @@ }, "x-appwrite": { "method": "listTemplates", - "weight": 394, + "group": "templates", + "weight": 401, "cookies": false, "type": "", "deprecated": false, @@ -9549,7 +10002,8 @@ }, "x-appwrite": { "method": "getTemplate", - "weight": 393, + "group": "templates", + "weight": 400, "cookies": false, "type": "", "deprecated": false, @@ -9608,7 +10062,8 @@ }, "x-appwrite": { "method": "listUsage", - "weight": 387, + "group": null, + "weight": 394, "cookies": false, "type": "", "deprecated": false, @@ -9679,7 +10134,8 @@ }, "x-appwrite": { "method": "get", - "weight": 366, + "group": "functions", + "weight": 373, "cookies": false, "type": "", "deprecated": false, @@ -9737,7 +10193,8 @@ }, "x-appwrite": { "method": "update", - "weight": 367, + "group": "functions", + "weight": 374, "cookies": false, "type": "", "deprecated": false, @@ -9964,7 +10421,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 369, + "group": "functions", + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -10024,7 +10482,8 @@ }, "x-appwrite": { "method": "updateFunctionDeployment", - "weight": 374, + "group": "functions", + "weight": 381, "cookies": false, "type": "", "deprecated": false, @@ -10103,7 +10562,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 375, + "group": "deployments", + "weight": 382, "cookies": false, "type": "", "deprecated": false, @@ -10185,7 +10645,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 372, + "group": "deployments", + "weight": 379, "cookies": false, "type": "upload", "deprecated": false, @@ -10280,7 +10741,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 380, + "group": "deployments", + "weight": 387, "cookies": false, "type": "", "deprecated": false, @@ -10364,7 +10826,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 377, + "group": "deployments", + "weight": 384, "cookies": false, "type": "", "deprecated": false, @@ -10466,7 +10929,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 378, + "group": "deployments", + "weight": 385, "cookies": false, "type": "", "deprecated": false, @@ -10562,7 +11026,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 373, + "group": "deployments", + "weight": 380, "cookies": false, "type": "", "deprecated": false, @@ -10623,7 +11088,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 376, + "group": "deployments", + "weight": 383, "cookies": false, "type": "", "deprecated": false, @@ -10673,7 +11139,7 @@ }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "functionsGetDeploymentDownload", "tags": [ "functions" @@ -10686,7 +11152,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 379, + "group": "deployments", + "weight": 386, "cookies": false, "type": "location", "deprecated": false, @@ -10775,7 +11242,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 381, + "group": "deployments", + "weight": 388, "cookies": false, "type": "", "deprecated": false, @@ -10845,7 +11313,8 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 384, + "group": "executions", + "weight": 391, "cookies": false, "type": "", "deprecated": false, @@ -10919,7 +11388,8 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 382, + "group": "executions", + "weight": 389, "cookies": false, "type": "", "deprecated": false, @@ -11033,7 +11503,8 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 383, + "group": "executions", + "weight": 390, "cookies": false, "type": "", "deprecated": false, @@ -11097,7 +11568,8 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 385, + "group": "executions", + "weight": 392, "cookies": false, "type": "", "deprecated": false, @@ -11167,7 +11639,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 386, + "group": null, + "weight": 393, "cookies": false, "type": "", "deprecated": false, @@ -11248,7 +11721,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 390, + "group": "variables", + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -11306,7 +11780,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 388, + "group": "variables", + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -11396,7 +11871,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 389, + "group": "variables", + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -11464,7 +11940,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 391, + "group": "variables", + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -11554,7 +12031,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 392, + "group": "variables", + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -11624,7 +12102,8 @@ }, "x-appwrite": { "method": "query", - "weight": 303, + "group": "graphql", + "weight": 305, "cookies": false, "type": "graphql", "deprecated": false, @@ -11675,7 +12154,8 @@ }, "x-appwrite": { "method": "mutation", - "weight": 302, + "group": "graphql", + "weight": 304, "cookies": false, "type": "graphql", "deprecated": false, @@ -11726,7 +12206,8 @@ }, "x-appwrite": { "method": "get", - "weight": 126, + "group": "health", + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -11774,7 +12255,8 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 148, + "group": "health", + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -11822,7 +12304,8 @@ }, "x-appwrite": { "method": "getCache", - "weight": 129, + "group": "health", + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -11870,7 +12353,8 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 134, + "group": "health", + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -11929,7 +12413,8 @@ }, "x-appwrite": { "method": "getDB", - "weight": 128, + "group": "health", + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -11977,7 +12462,8 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 130, + "group": "health", + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -12025,7 +12511,8 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 136, + "group": "queue", + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -12086,7 +12573,8 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 135, + "group": "queue", + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -12147,7 +12635,8 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 137, + "group": "queue", + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -12219,7 +12708,8 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 138, + "group": "queue", + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -12280,7 +12770,8 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 149, + "group": "queue", + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -12320,7 +12811,6 @@ "v1-functions", "v1-stats-resources", "v1-stats-usage", - "v1-stats-usage-dump", "v1-webhooks", "v1-certificates", "v1-builds", @@ -12368,7 +12858,8 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 142, + "group": "queue", + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -12429,7 +12920,8 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 133, + "group": "queue", + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -12490,7 +12982,8 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 139, + "group": "queue", + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -12551,7 +13044,8 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 140, + "group": "queue", + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -12612,7 +13106,8 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 141, + "group": "queue", + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -12673,7 +13168,8 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 143, + "group": "queue", + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -12734,7 +13230,8 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 144, + "group": "queue", + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -12773,67 +13270,6 @@ ] } }, - "\/health\/queue\/stats-usage-dump": { - "get": { - "summary": "Get usage dump queue", - "operationId": "healthGetQueueStatsUsageDump", - "tags": [ - "health" - ], - "description": "Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.", - "responses": { - "200": { - "description": "Health Queue", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/healthQueue" - } - } - } - } - }, - "x-appwrite": { - "method": "getQueueStatsUsageDump", - "weight": 145, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "health\/get-queue-stats-usage-dump.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-usage-dump.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "health.read", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "threshold", - "description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 5000 - }, - "in": "query" - } - ] - } - }, "\/health\/queue\/webhooks": { "get": { "summary": "Get webhooks queue", @@ -12856,7 +13292,8 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 132, + "group": "queue", + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -12917,7 +13354,8 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 147, + "group": "storage", + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -12965,7 +13403,8 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 146, + "group": "storage", + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -13013,7 +13452,8 @@ }, "x-appwrite": { "method": "getTime", - "weight": 131, + "group": "health", + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -13061,7 +13501,8 @@ }, "x-appwrite": { "method": "get", - "weight": 118, + "group": null, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -13112,7 +13553,8 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 119, + "group": null, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -13163,7 +13605,8 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 123, + "group": null, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -13214,7 +13657,8 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 120, + "group": null, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -13265,7 +13709,8 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 121, + "group": null, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -13316,7 +13761,8 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 122, + "group": null, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -13367,7 +13813,8 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 124, + "group": null, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -13418,7 +13865,8 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 125, + "group": null, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -13469,7 +13917,8 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 357, + "group": "messages", + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -13544,7 +13993,8 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 354, + "group": "messages", + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -13687,7 +14137,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 361, + "group": "messages", + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -13832,7 +14283,8 @@ }, "x-appwrite": { "method": "createPush", - "weight": 356, + "group": "messages", + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -14005,7 +14457,8 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 363, + "group": "messages", + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -14182,7 +14635,8 @@ }, "x-appwrite": { "method": "createSms", - "weight": 355, + "group": "messages", + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -14290,7 +14744,8 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 362, + "group": "messages", + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -14401,7 +14856,8 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 360, + "group": "messages", + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -14453,7 +14909,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 364, + "group": "messages", + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -14514,7 +14971,8 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 358, + "group": "logs", + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -14588,7 +15046,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 359, + "group": "messages", + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -14662,7 +15121,8 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 329, + "group": "providers", + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -14737,7 +15197,8 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 328, + "group": "providers", + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -14841,7 +15302,8 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 341, + "group": "providers", + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -14948,7 +15410,8 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 327, + "group": "providers", + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -15032,7 +15495,8 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 340, + "group": "providers", + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -15119,7 +15583,8 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 319, + "group": "providers", + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -15233,7 +15698,8 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 332, + "group": "providers", + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -15350,7 +15816,8 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 322, + "group": "providers", + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -15444,7 +15911,8 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 335, + "group": "providers", + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -15541,7 +16009,8 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 320, + "group": "providers", + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -15645,7 +16114,8 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 333, + "group": "providers", + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -15752,7 +16222,8 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 321, + "group": "providers", + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -15894,7 +16365,8 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 334, + "group": "providers", + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -16038,7 +16510,8 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 323, + "group": "providers", + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -16132,7 +16605,8 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 336, + "group": "providers", + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -16229,7 +16703,8 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 324, + "group": "providers", + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -16323,7 +16798,8 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 337, + "group": "providers", + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -16420,7 +16896,8 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 325, + "group": "providers", + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -16514,7 +16991,8 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 338, + "group": "providers", + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -16611,7 +17089,8 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 326, + "group": "providers", + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -16705,7 +17184,8 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 339, + "group": "providers", + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -16802,7 +17282,8 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 331, + "group": "providers", + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -16854,7 +17335,8 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 342, + "group": "providers", + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -16915,7 +17397,8 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 330, + "group": "providers", + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -16989,7 +17472,8 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 351, + "group": "subscribers", + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -17063,7 +17547,8 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 344, + "group": "topics", + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -17136,7 +17621,8 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 343, + "group": "topics", + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -17218,7 +17704,8 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 346, + "group": "topics", + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -17277,7 +17764,8 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 347, + "group": "topics", + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -17353,7 +17841,8 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 348, + "group": "topics", + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -17414,7 +17903,8 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 345, + "group": "topics", + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -17488,7 +17978,8 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 350, + "group": "subscribers", + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -17571,7 +18062,8 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 349, + "group": "subscribers", + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -17660,7 +18152,8 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 352, + "group": "subscribers", + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -17722,7 +18215,8 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 353, + "group": "subscribers", + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -17796,7 +18290,8 @@ }, "x-appwrite": { "method": "list", - "weight": 311, + "group": null, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -17849,7 +18344,7 @@ }, "\/migrations\/appwrite": { "post": { - "summary": "Migrate Appwrite data", + "summary": "Create Appwrite migration", "operationId": "migrationsCreateAppwriteMigration", "tags": [ "migrations" @@ -17869,7 +18364,8 @@ }, "x-appwrite": { "method": "createAppwriteMigration", - "weight": 306, + "group": null, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -17936,7 +18432,7 @@ }, "\/migrations\/appwrite\/report": { "get": { - "summary": "Generate a report on Appwrite data", + "summary": "Get Appwrite migration report", "operationId": "migrationsGetAppwriteReport", "tags": [ "migrations" @@ -17956,7 +18452,8 @@ }, "x-appwrite": { "method": "getAppwriteReport", - "weight": 313, + "group": null, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -18048,7 +18545,8 @@ }, "x-appwrite": { "method": "createCsvMigration", - "weight": 310, + "group": null, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -18106,7 +18604,7 @@ }, "\/migrations\/firebase": { "post": { - "summary": "Migrate Firebase data", + "summary": "Create Firebase migration", "operationId": "migrationsCreateFirebaseMigration", "tags": [ "migrations" @@ -18126,7 +18624,8 @@ }, "x-appwrite": { "method": "createFirebaseMigration", - "weight": 307, + "group": null, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -18181,7 +18680,7 @@ }, "\/migrations\/firebase\/report": { "get": { - "summary": "Generate a report on Firebase data", + "summary": "Get Firebase migration report", "operationId": "migrationsGetFirebaseReport", "tags": [ "migrations" @@ -18201,7 +18700,8 @@ }, "x-appwrite": { "method": "getFirebaseReport", - "weight": 314, + "group": null, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -18252,7 +18752,7 @@ }, "\/migrations\/nhost": { "post": { - "summary": "Migrate NHost data", + "summary": "Create NHost migration", "operationId": "migrationsCreateNHostMigration", "tags": [ "migrations" @@ -18272,7 +18772,8 @@ }, "x-appwrite": { "method": "createNHostMigration", - "weight": 309, + "group": null, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -18362,7 +18863,7 @@ }, "\/migrations\/nhost\/report": { "get": { - "summary": "Generate a report on NHost Data", + "summary": "Get NHost migration report", "operationId": "migrationsGetNHostReport", "tags": [ "migrations" @@ -18382,7 +18883,8 @@ }, "x-appwrite": { "method": "getNHostReport", - "weight": 316, + "group": null, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -18494,7 +18996,7 @@ }, "\/migrations\/supabase": { "post": { - "summary": "Migrate Supabase data", + "summary": "Create Supabase migration", "operationId": "migrationsCreateSupabaseMigration", "tags": [ "migrations" @@ -18514,7 +19016,8 @@ }, "x-appwrite": { "method": "createSupabaseMigration", - "weight": 308, + "group": null, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -18598,7 +19101,7 @@ }, "\/migrations\/supabase\/report": { "get": { - "summary": "Generate a report on Supabase Data", + "summary": "Get Supabase migration report", "operationId": "migrationsGetSupabaseReport", "tags": [ "migrations" @@ -18618,7 +19121,8 @@ }, "x-appwrite": { "method": "getSupabaseReport", - "weight": 315, + "group": null, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -18741,7 +19245,8 @@ }, "x-appwrite": { "method": "get", - "weight": 312, + "group": null, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -18778,7 +19283,7 @@ ] }, "patch": { - "summary": "Retry migration", + "summary": "Update retry migration", "operationId": "migrationsRetry", "tags": [ "migrations" @@ -18798,7 +19303,8 @@ }, "x-appwrite": { "method": "retry", - "weight": 317, + "group": null, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -18848,7 +19354,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 318, + "group": null, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -18907,7 +19414,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 197, + "group": null, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -18994,7 +19502,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 199, + "group": null, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -19039,7 +19548,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 198, + "group": null, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -19116,7 +19626,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 200, + "group": null, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -19173,7 +19684,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 201, + "group": null, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -19252,7 +19764,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 202, + "group": null, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -19311,7 +19824,8 @@ }, "x-appwrite": { "method": "list", - "weight": 152, + "group": "projects", + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -19382,7 +19896,8 @@ }, "x-appwrite": { "method": "create", - "weight": 151, + "group": "projects", + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -19515,7 +20030,8 @@ }, "x-appwrite": { "method": "get", - "weight": 153, + "group": "projects", + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -19572,7 +20088,8 @@ }, "x-appwrite": { "method": "update", - "weight": 154, + "group": "projects", + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -19686,7 +20203,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 171, + "group": "projects", + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -19745,7 +20263,8 @@ }, "x-appwrite": { "method": "updateApiStatus", - "weight": 158, + "group": "projects", + "weight": 160, "cookies": false, "type": "", "deprecated": false, @@ -19836,7 +20355,8 @@ }, "x-appwrite": { "method": "updateApiStatusAll", - "weight": 159, + "group": "projects", + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -19914,7 +20434,8 @@ }, "x-appwrite": { "method": "updateAuthDuration", - "weight": 164, + "group": "auth", + "weight": 166, "cookies": false, "type": "", "deprecated": false, @@ -19992,7 +20513,8 @@ }, "x-appwrite": { "method": "updateAuthLimit", - "weight": 163, + "group": "auth", + "weight": 165, "cookies": false, "type": "", "deprecated": false, @@ -20070,7 +20592,8 @@ }, "x-appwrite": { "method": "updateAuthSessionsLimit", - "weight": 169, + "group": "auth", + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -20148,7 +20671,8 @@ }, "x-appwrite": { "method": "updateMembershipsPrivacy", - "weight": 162, + "group": "auth", + "weight": 164, "cookies": false, "type": "", "deprecated": false, @@ -20238,7 +20762,8 @@ }, "x-appwrite": { "method": "updateMockNumbers", - "weight": 170, + "group": "auth", + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -20319,7 +20844,8 @@ }, "x-appwrite": { "method": "updateAuthPasswordDictionary", - "weight": 167, + "group": "auth", + "weight": 169, "cookies": false, "type": "", "deprecated": false, @@ -20397,7 +20923,8 @@ }, "x-appwrite": { "method": "updateAuthPasswordHistory", - "weight": 166, + "group": "auth", + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -20455,7 +20982,7 @@ }, "\/projects\/{projectId}\/auth\/personal-data": { "patch": { - "summary": "Enable or disable checking user passwords for similarity with their personal data.", + "summary": "Update personal data check", "operationId": "projectsUpdatePersonalDataCheck", "tags": [ "projects" @@ -20475,7 +21002,8 @@ }, "x-appwrite": { "method": "updatePersonalDataCheck", - "weight": 168, + "group": "auth", + "weight": 170, "cookies": false, "type": "", "deprecated": false, @@ -20553,7 +21081,8 @@ }, "x-appwrite": { "method": "updateSessionAlerts", - "weight": 161, + "group": "auth", + "weight": 163, "cookies": false, "type": "", "deprecated": false, @@ -20631,7 +21160,8 @@ }, "x-appwrite": { "method": "updateAuthStatus", - "weight": 165, + "group": "auth", + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -20708,38 +21238,39 @@ } } }, - "\/projects\/{projectId}\/jwts": { - "post": { - "summary": "Create JWT", - "operationId": "projectsCreateJWT", + "\/projects\/{projectId}\/dev-keys": { + "get": { + "summary": "List dev keys", + "operationId": "projectsListDevKeys", "tags": [ "projects" ], - "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", + "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": { - "201": { - "description": "JWT", + "200": { + "description": "Dev Keys List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/jwt" + "$ref": "#\/components\/schemas\/devKeyList" } } } } }, "x-appwrite": { - "method": "createJWT", - "weight": 183, + "method": "listDevKeys", + "group": "devKeys", + "weight": 370, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/create-j-w-t.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", + "demo": "projects\/list-dev-keys.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "projects.read", "platforms": [ "console" ], @@ -20763,126 +21294,51 @@ "x-example": "" }, "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "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" - } - }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "x-example": 0 - } - }, - "required": [ - "scopes" - ] - } - } - } - } - } - }, - "\/projects\/{projectId}\/keys": { - "get": { - "summary": "List keys", - "operationId": "projectsListKeys", - "tags": [ - "projects" - ], - "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" - } - } - } - } - }, - "x-appwrite": { - "method": "listKeys", - "weight": 179, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "projects\/list-keys.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-keys.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", - "platforms": [ - "console" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "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: accessedAt, expire", + "required": false, "schema": { "type": "string", - "x-example": "" + "default": [] }, - "in": "path" + "in": "query" } ] }, "post": { - "summary": "Create key", - "operationId": "projectsCreateKey", + "summary": "Create dev key", + "operationId": "projectsCreateDevKey", "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": "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": { "201": { - "description": "Key", + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/devKey" } } } } }, "x-appwrite": { - "method": "createKey", - "weight": 178, + "method": "createDevKey", + "group": "devKeys", + "weight": 367, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/create-key.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-key.md", + "demo": "projects\/create-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], @@ -20919,23 +21375,15 @@ "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" - } - }, "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.", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", "x-example": null } }, "required": [ "name", - "scopes" + "expire" ] } } @@ -20943,38 +21391,39 @@ } } }, - "\/projects\/{projectId}\/keys\/{keyId}": { + "\/projects\/{projectId}\/dev-keys\/{keyId}": { "get": { - "summary": "Get key", - "operationId": "projectsGetKey", + "summary": "Get dev key", + "operationId": "projectsGetDevKey", "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": "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": "Key", + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/devKey" } } } } }, "x-appwrite": { - "method": "getKey", - "weight": 180, + "method": "getDevKey", + "group": "devKeys", + "weight": 369, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/get-key.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-key.md", + "demo": "projects\/get-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", + "scope": "projects.read", "platforms": [ "console" ], @@ -21012,36 +21461,37 @@ ] }, "put": { - "summary": "Update key", - "operationId": "projectsUpdateKey", + "summary": "Update dev key", + "operationId": "projectsUpdateDevKey", "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 a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", "responses": { "200": { - "description": "Key", + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/devKey" } } } } }, "x-appwrite": { - "method": "updateKey", - "weight": 181, + "method": "updateDevKey", + "group": "devKeys", + "weight": 368, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-key.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-key.md", + "demo": "projects\/update-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "projects.write", "platforms": [ "console" ], @@ -21088,23 +21538,15 @@ "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" - } - }, "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.", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", "x-example": null } }, "required": [ "name", - "scopes" + "expire" ] } } @@ -21112,94 +21554,566 @@ } }, "delete": { - "summary": "Delete key", - "operationId": "projectsDeleteKey", + "summary": "Delete dev key", + "operationId": "projectsDeleteDevKey", "tags": [ "projects" ], - "description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls. ", + "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": { "204": { "description": "No content" } }, "x-appwrite": { - "method": "deleteKey", - "weight": 182, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "projects\/delete-key.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-key.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", - "platforms": [ - "console" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/projects\/{projectId}\/oauth2": { - "patch": { - "summary": "Update project OAuth2", - "operationId": "projectsUpdateOAuth2", - "tags": [ - "projects" - ], - "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", - "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } - } - }, - "x-appwrite": { - "method": "updateOAuth2", - "weight": 160, + "method": "deleteDevKey", + "group": "devKeys", + "weight": 371, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-o-auth2.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", + "demo": "projects\/delete-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "keyId", + "description": "Key unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/projects\/{projectId}\/jwts": { + "post": { + "summary": "Create JWT", + "operationId": "projectsCreateJWT", + "tags": [ + "projects" + ], + "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", + "responses": { + "201": { + "description": "JWT", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/jwt" + } + } + } + } + }, + "x-appwrite": { + "method": "createJWT", + "group": "auth", + "weight": 185, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/create-j-w-t.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "type": "array", + "description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "duration": { + "type": "integer", + "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "x-example": 0 + } + }, + "required": [ + "scopes" + ] + } + } + } + } + } + }, + "\/projects\/{projectId}\/keys": { + "get": { + "summary": "List keys", + "operationId": "projectsListKeys", + "tags": [ + "projects" + ], + "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" + } + } + } + } + }, + "x-appwrite": { + "method": "listKeys", + "group": "keys", + "weight": 181, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/list-keys.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-keys.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "post": { + "summary": "Create key", + "operationId": "projectsCreateKey", + "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.", + "responses": { + "201": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "x-appwrite": { + "method": "createKey", + "group": "keys", + "weight": 180, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/create-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "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" + } + }, + "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 + } + }, + "required": [ + "name", + "scopes" + ] + } + } + } + } + } + }, + "\/projects\/{projectId}\/keys\/{keyId}": { + "get": { + "summary": "Get key", + "operationId": "projectsGetKey", + "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.", + "responses": { + "200": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "x-appwrite": { + "method": "getKey", + "group": "keys", + "weight": 182, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/get-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique 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" + } + ] + }, + "put": { + "summary": "Update key", + "operationId": "projectsUpdateKey", + "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. ", + "responses": { + "200": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "x-appwrite": { + "method": "updateKey", + "group": "keys", + "weight": 183, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "keyId", + "description": "Key unique 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 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "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 + } + }, + "required": [ + "name", + "scopes" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete key", + "operationId": "projectsDeleteKey", + "tags": [ + "projects" + ], + "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" + } + }, + "x-appwrite": { + "method": "deleteKey", + "group": "keys", + "weight": 184, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/delete-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "keyId", + "description": "Key unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/projects\/{projectId}\/oauth2": { + "patch": { + "summary": "Update project OAuth2", + "operationId": "projectsUpdateOAuth2", + "tags": [ + "projects" + ], + "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "x-appwrite": { + "method": "updateOAuth2", + "group": "auth", + "weight": 162, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-o-auth2.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -21254,6 +22168,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -21330,7 +22245,8 @@ }, "x-appwrite": { "method": "listPlatforms", - "weight": 185, + "group": "platforms", + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -21387,7 +22303,8 @@ }, "x-appwrite": { "method": "createPlatform", - "weight": 184, + "group": "platforms", + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -21505,7 +22422,8 @@ }, "x-appwrite": { "method": "getPlatform", - "weight": 186, + "group": "platforms", + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -21572,7 +22490,8 @@ }, "x-appwrite": { "method": "updatePlatform", - "weight": 187, + "group": "platforms", + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -21666,7 +22585,8 @@ }, "x-appwrite": { "method": "deletePlatform", - "weight": 188, + "group": "platforms", + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -21735,7 +22655,8 @@ }, "x-appwrite": { "method": "updateServiceStatus", - "weight": 156, + "group": "projects", + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -21835,7 +22756,8 @@ }, "x-appwrite": { "method": "updateServiceStatusAll", - "weight": 157, + "group": "projects", + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -21913,7 +22835,8 @@ }, "x-appwrite": { "method": "updateSmtp", - "weight": 189, + "group": "templates", + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -22030,7 +22953,8 @@ }, "x-appwrite": { "method": "createSmtpTest", - "weight": 190, + "group": "templates", + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -22160,7 +23084,8 @@ }, "x-appwrite": { "method": "updateTeam", - "weight": 155, + "group": "projects", + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -22238,7 +23163,8 @@ }, "x-appwrite": { "method": "getEmailTemplate", - "weight": 192, + "group": "templates", + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22461,7 +23387,8 @@ }, "x-appwrite": { "method": "updateEmailTemplate", - "weight": 194, + "group": "templates", + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -22704,7 +23631,7 @@ } }, "delete": { - "summary": "Reset custom email template", + "summary": "Delete custom email template", "operationId": "projectsDeleteEmailTemplate", "tags": [ "projects" @@ -22724,7 +23651,8 @@ }, "x-appwrite": { "method": "deleteEmailTemplate", - "weight": 196, + "group": "templates", + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -22949,7 +23877,8 @@ }, "x-appwrite": { "method": "getSmsTemplate", - "weight": 191, + "group": "templates", + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -23169,7 +24098,8 @@ }, "x-appwrite": { "method": "updateSmsTemplate", - "weight": 193, + "group": "templates", + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23408,7 +24338,8 @@ }, "x-appwrite": { "method": "deleteSmsTemplate", - "weight": 195, + "group": "templates", + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -23630,7 +24561,8 @@ }, "x-appwrite": { "method": "listWebhooks", - "weight": 173, + "group": "webhooks", + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -23687,7 +24619,8 @@ }, "x-appwrite": { "method": "createWebhook", - "weight": 172, + "group": "webhooks", + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -23801,7 +24734,8 @@ }, "x-appwrite": { "method": "getWebhook", - "weight": 174, + "group": "webhooks", + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -23868,7 +24802,8 @@ }, "x-appwrite": { "method": "updateWebhook", - "weight": 175, + "group": "webhooks", + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -23983,7 +24918,8 @@ }, "x-appwrite": { "method": "deleteWebhook", - "weight": 177, + "group": "webhooks", + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -24052,7 +24988,8 @@ }, "x-appwrite": { "method": "updateWebhookSignature", - "weight": 176, + "group": "webhooks", + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -24121,7 +25058,8 @@ }, "x-appwrite": { "method": "listRules", - "weight": 289, + "group": null, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -24194,7 +25132,8 @@ }, "x-appwrite": { "method": "createAPIRule", - "weight": 425, + "group": null, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -24260,7 +25199,8 @@ }, "x-appwrite": { "method": "createFunctionRule", - "weight": 427, + "group": null, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -24337,7 +25277,8 @@ }, "x-appwrite": { "method": "createRedirectRule", - "weight": 428, + "group": null, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -24428,7 +25369,8 @@ }, "x-appwrite": { "method": "createSiteRule", - "weight": 426, + "group": null, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -24505,7 +25447,8 @@ }, "x-appwrite": { "method": "getRule", - "weight": 290, + "group": null, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -24555,7 +25498,8 @@ }, "x-appwrite": { "method": "deleteRule", - "weight": 291, + "group": null, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -24614,7 +25558,8 @@ }, "x-appwrite": { "method": "updateRuleVerification", - "weight": 292, + "group": null, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -24673,7 +25618,8 @@ }, "x-appwrite": { "method": "list", - "weight": 397, + "group": "sites", + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -24742,7 +25688,8 @@ }, "x-appwrite": { "method": "create", - "weight": 395, + "group": "sites", + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -24798,6 +25745,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -24987,7 +25935,8 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 400, + "group": "frameworks", + "weight": 407, "cookies": false, "type": "", "deprecated": false, @@ -25035,7 +25984,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 423, + "group": "frameworks", + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -25084,7 +26034,8 @@ }, "x-appwrite": { "method": "listTemplates", - "weight": 419, + "group": "templates", + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -25183,7 +26134,8 @@ }, "x-appwrite": { "method": "getTemplate", - "weight": 420, + "group": "templates", + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -25242,7 +26194,8 @@ }, "x-appwrite": { "method": "listUsage", - "weight": 421, + "group": null, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -25313,7 +26266,8 @@ }, "x-appwrite": { "method": "get", - "weight": 396, + "group": "sites", + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -25371,7 +26325,8 @@ }, "x-appwrite": { "method": "update", - "weight": 398, + "group": "sites", + "weight": 405, "cookies": false, "type": "", "deprecated": false, @@ -25434,6 +26389,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -25612,7 +26568,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 399, + "group": "sites", + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -25672,7 +26629,8 @@ }, "x-appwrite": { "method": "updateSiteDeployment", - "weight": 406, + "group": "sites", + "weight": 413, "cookies": false, "type": "", "deprecated": false, @@ -25751,7 +26709,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 405, + "group": "deployments", + "weight": 412, "cookies": false, "type": "", "deprecated": false, @@ -25833,7 +26792,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 401, + "group": "deployments", + "weight": 408, "cookies": false, "type": "upload", "deprecated": false, @@ -25933,7 +26893,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 409, + "group": "deployments", + "weight": 416, "cookies": false, "type": "", "deprecated": false, @@ -26012,7 +26973,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 402, + "group": "deployments", + "weight": 409, "cookies": false, "type": "", "deprecated": false, @@ -26114,7 +27076,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 403, + "group": "deployments", + "weight": 410, "cookies": false, "type": "", "deprecated": false, @@ -26211,7 +27174,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 404, + "group": "deployments", + "weight": 411, "cookies": false, "type": "", "deprecated": false, @@ -26272,7 +27236,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 407, + "group": "deployments", + "weight": 414, "cookies": false, "type": "", "deprecated": false, @@ -26322,7 +27287,7 @@ }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "sitesGetDeploymentDownload", "tags": [ "sites" @@ -26335,7 +27300,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 408, + "group": "deployments", + "weight": 415, "cookies": false, "type": "location", "deprecated": false, @@ -26424,7 +27390,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 410, + "group": "deployments", + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -26494,7 +27461,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 412, + "group": "logs", + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -26564,7 +27532,8 @@ }, "x-appwrite": { "method": "getLog", - "weight": 411, + "group": "logs", + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -26625,7 +27594,8 @@ }, "x-appwrite": { "method": "deleteLog", - "weight": 413, + "group": "logs", + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -26695,7 +27665,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 422, + "group": null, + "weight": 429, "cookies": false, "type": "", "deprecated": false, @@ -26776,7 +27747,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 416, + "group": "variables", + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -26834,7 +27806,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 414, + "group": "variables", + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -26924,7 +27897,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 415, + "group": "variables", + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -26992,7 +27966,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 417, + "group": "variables", + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -27082,7 +28057,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 418, + "group": "variables", + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -27152,7 +28128,8 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 204, + "group": "buckets", + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -27224,7 +28201,8 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 203, + "group": "buckets", + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -27350,7 +28328,8 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 205, + "group": "buckets", + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -27408,7 +28387,8 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 206, + "group": "buckets", + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -27531,7 +28511,8 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 207, + "group": "buckets", + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -27591,7 +28572,8 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 209, + "group": "files", + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -27676,7 +28658,8 @@ }, "x-appwrite": { "method": "createFile", - "weight": 208, + "group": "files", + "weight": 210, "cookies": false, "type": "upload", "deprecated": false, @@ -27773,7 +28756,8 @@ }, "x-appwrite": { "method": "getFile", - "weight": 210, + "group": "files", + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -27844,7 +28828,8 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 215, + "group": "files", + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -27932,7 +28917,8 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 216, + "group": "files", + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -27998,7 +28984,8 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 212, + "group": "files", + "weight": 214, "cookies": false, "type": "location", "deprecated": false, @@ -28045,6 +29032,17 @@ "x-example": "" }, "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -28064,7 +29062,8 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 211, + "group": "files", + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -28104,7 +29103,235 @@ }, { "name": "fileId", - "description": "File ID", + "description": "File ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "width", + "description": "Resize preview image width, Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "height", + "description": "Resize preview image height, Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "gravity", + "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "required": false, + "schema": { + "type": "string", + "x-example": "center", + "enum": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], + "x-enum-name": "ImageGravity", + "x-enum-keys": [], + "default": "center" + }, + "in": "query" + }, + { + "name": "quality", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1 + }, + "in": "query" + }, + { + "name": "borderWidth", + "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "borderColor", + "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", + "required": false, + "schema": { + "type": "string", + "default": "" + }, + "in": "query" + }, + { + "name": "borderRadius", + "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "opacity", + "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", + "required": false, + "schema": { + "type": "number", + "format": "float", + "x-example": 0, + "default": 1 + }, + "in": "query" + }, + { + "name": "rotation", + "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -360, + "default": 0 + }, + "in": "query" + }, + { + "name": "background", + "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", + "required": false, + "schema": { + "type": "string", + "default": "" + }, + "in": "query" + }, + { + "name": "output", + "description": "Output format type (jpeg, jpg, png, gif and webp).", + "required": false, + "schema": { + "type": "string", + "x-example": "jpg", + "enum": [ + "jpg", + "jpeg", + "gif", + "png", + "webp", + "heic", + "avif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "" + }, + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "get": { + "summary": "Get file for view", + "operationId": "storageGetFileView", + "tags": [ + "storage" + ], + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", + "responses": { + "200": { + "description": "File" + } + }, + "x-appwrite": { + "method": "getFileView", + "group": "files", + "weight": 215, + "cookies": false, + "type": "location", + "deprecated": false, + "demo": "storage\/get-file-view.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", @@ -28113,151 +29340,12 @@ "in": "path" }, { - "name": "width", - "description": "Resize preview image width, Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "height", - "description": "Resize preview image height, Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "gravity", - "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "name": "token", + "description": "File token for accessing this file.", "required": false, "schema": { "type": "string", - "x-example": "center", - "enum": [ - "center", - "top-left", - "top", - "top-right", - "left", - "right", - "bottom-left", - "bottom", - "bottom-right" - ], - "x-enum-name": "ImageGravity", - "x-enum-keys": [], - "default": "center" - }, - "in": "query" - }, - { - "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to 100.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 100 - }, - "in": "query" - }, - { - "name": "borderWidth", - "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "borderColor", - "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", - "required": false, - "schema": { - "type": "string", - "default": "" - }, - "in": "query" - }, - { - "name": "borderRadius", - "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "opacity", - "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", - "required": false, - "schema": { - "type": "number", - "format": "float", - "x-example": 0, - "default": 1 - }, - "in": "query" - }, - { - "name": "rotation", - "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": -360, - "default": 0 - }, - "in": "query" - }, - { - "name": "background", - "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", - "required": false, - "schema": { - "type": "string", - "default": "" - }, - "in": "query" - }, - { - "name": "output", - "description": "Output format type (jpeg, jpg, png, gif and webp).", - "required": false, - "schema": { - "type": "string", - "x-example": "jpg", - "enum": [ - "jpg", - "jpeg", - "gif", - "png", - "webp", - "heic", - "avif" - ], - "x-enum-name": "ImageFormat", - "x-enum-keys": [], + "x-example": "", "default": "" }, "in": "query" @@ -28265,72 +29353,6 @@ ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { - "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", - "tags": [ - "storage" - ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", - "responses": { - "200": { - "description": "File" - } - }, - "x-appwrite": { - "method": "getFileView", - "weight": 213, - "cookies": false, - "type": "location", - "deprecated": false, - "demo": "storage\/get-file-view.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, "\/storage\/usage": { "get": { "summary": "Get storage usage stats", @@ -28353,7 +29375,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 217, + "group": null, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -28424,7 +29447,8 @@ }, "x-appwrite": { "method": "getBucketUsage", - "weight": 218, + "group": null, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -28505,7 +29529,8 @@ }, "x-appwrite": { "method": "list", - "weight": 220, + "group": "teams", + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -28580,7 +29605,8 @@ }, "x-appwrite": { "method": "create", - "weight": 219, + "group": "teams", + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -28664,7 +29690,8 @@ }, "x-appwrite": { "method": "get", - "weight": 221, + "group": "teams", + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -28725,7 +29752,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 223, + "group": "teams", + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -28798,7 +29826,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 225, + "group": "teams", + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -28861,7 +29890,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 232, + "group": "logs", + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -28933,7 +29963,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 227, + "group": "memberships", + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -29018,7 +30049,8 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 226, + "group": "memberships", + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -29128,7 +30160,8 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 228, + "group": "memberships", + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -29199,7 +30232,8 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 229, + "group": "memberships", + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -29285,7 +30319,8 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 231, + "group": "memberships", + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -29358,7 +30393,8 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 230, + "group": "memberships", + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -29454,7 +30490,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 222, + "group": "teams", + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -29513,7 +30550,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 224, + "group": "teams", + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -29593,7 +30631,8 @@ }, "x-appwrite": { "method": "list", - "weight": 432, + "group": "files", + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -29604,8 +30643,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -29616,8 +30654,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -29659,7 +30696,7 @@ "tags": [ "tokens" ], - "description": "Create a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "description": "Create a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "responses": { "201": { "description": "ResourceToken", @@ -29674,19 +30711,19 @@ }, "x-appwrite": { "method": "createFileToken", - "weight": 429, + "group": "files", + "weight": 436, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/create-file-token.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -29697,8 +30734,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -29734,14 +30770,6 @@ "description": "Token expiry date", "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -29772,7 +30800,8 @@ }, "x-appwrite": { "method": "get", - "weight": 430, + "group": "tokens", + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -29783,8 +30812,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -29795,8 +30823,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -29818,7 +30845,7 @@ "tags": [ "tokens" ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { "200": { "description": "ResourceToken", @@ -29833,19 +30860,19 @@ }, "x-appwrite": { "method": "update", - "weight": 433, + "group": "tokens", + "weight": 439, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/update.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -29856,8 +30883,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -29883,14 +30909,6 @@ "description": "File token expiry date", "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -29912,7 +30930,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 434, + "group": "tokens", + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -29923,8 +30942,7 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -29935,8 +30953,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -29953,69 +30970,6 @@ ] } }, - "\/tokens\/{tokenId}\/jwt": { - "get": { - "summary": "Get token as JWT", - "operationId": "tokensGetJWT", - "tags": [ - "tokens" - ], - "description": "Get a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "responses": { - "200": { - "description": "JWT", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/jwt" - } - } - } - } - }, - "x-appwrite": { - "method": "getJWT", - "weight": 431, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get-j-w-t.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "File token ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, "\/users": { "get": { "summary": "List users", @@ -30038,7 +30992,8 @@ }, "x-appwrite": { "method": "list", - "weight": 242, + "group": "users", + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -30110,7 +31065,8 @@ }, "x-appwrite": { "method": "create", - "weight": 233, + "group": "users", + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -30197,7 +31153,8 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 236, + "group": "users", + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -30281,7 +31238,8 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 234, + "group": "users", + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -30365,7 +31323,8 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 250, + "group": "identities", + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -30432,7 +31391,8 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 273, + "group": "identities", + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -30492,7 +31452,8 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 235, + "group": "users", + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -30576,7 +31537,8 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 238, + "group": "users", + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -30660,7 +31622,8 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 239, + "group": "users", + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -30774,7 +31737,8 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 240, + "group": "users", + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -30876,7 +31840,8 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 237, + "group": "users", + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -30980,7 +31945,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 275, + "group": null, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -31051,7 +32017,8 @@ }, "x-appwrite": { "method": "get", - "weight": 243, + "group": "users", + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -31102,7 +32069,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 271, + "group": "users", + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -31162,7 +32130,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 256, + "group": "users", + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -31241,7 +32210,8 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 274, + "group": "sessions", + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -31322,7 +32292,8 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 252, + "group": "users", + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -31404,7 +32375,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 248, + "group": "logs", + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -31477,7 +32449,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 247, + "group": "memberships", + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -31561,7 +32534,8 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 261, + "group": "users", + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -31633,7 +32607,8 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 266, + "group": "mfa", + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -31708,7 +32683,8 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 262, + "group": "mfa", + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -31768,7 +32744,8 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 263, + "group": "mfa", + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -31806,7 +32783,7 @@ ] }, "put": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "usersUpdateMfaRecoveryCodes", "tags": [ "users" @@ -31826,7 +32803,8 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 265, + "group": "mfa", + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -31884,7 +32862,8 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 264, + "group": "mfa", + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -31944,7 +32923,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 254, + "group": "users", + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -32023,7 +33003,8 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 255, + "group": "users", + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -32102,7 +33083,8 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 257, + "group": "users", + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -32181,7 +33163,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 244, + "group": "users", + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -32239,7 +33222,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 259, + "group": "users", + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -32318,7 +33302,8 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 246, + "group": "sessions", + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -32376,7 +33361,8 @@ }, "x-appwrite": { "method": "createSession", - "weight": 267, + "group": "sessions", + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -32427,7 +33413,8 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 270, + "group": "sessions", + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -32480,7 +33467,8 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 269, + "group": "sessions", + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -32550,7 +33538,8 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 251, + "group": "users", + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -32629,7 +33618,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 249, + "group": "targets", + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -32701,7 +33691,8 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 241, + "group": "targets", + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -32810,7 +33801,8 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 245, + "group": "targets", + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -32879,7 +33871,8 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 260, + "group": "targets", + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -32967,7 +33960,8 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 272, + "group": "targets", + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -33038,7 +34032,8 @@ }, "x-appwrite": { "method": "createToken", - "weight": 268, + "group": "sessions", + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -33119,7 +34114,8 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 258, + "group": "users", + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -33198,7 +34194,8 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 253, + "group": "users", + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -33277,7 +34274,8 @@ }, "x-appwrite": { "method": "createRepositoryDetection", - "weight": 279, + "group": "repositories", + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -33372,7 +34370,8 @@ }, "x-appwrite": { "method": "listRepositories", - "weight": 280, + "group": "repositories", + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -33456,7 +34455,8 @@ }, "x-appwrite": { "method": "createRepository", - "weight": 281, + "group": "repositories", + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -33540,7 +34540,8 @@ }, "x-appwrite": { "method": "getRepository", - "weight": 282, + "group": "repositories", + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -33609,7 +34610,8 @@ }, "x-appwrite": { "method": "listRepositoryBranches", - "weight": 283, + "group": "repositories", + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -33678,7 +34680,8 @@ }, "x-appwrite": { "method": "getRepositoryContents", - "weight": 278, + "group": "repositories", + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -33738,7 +34741,7 @@ }, "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { "patch": { - "summary": "Authorize external deployment", + "summary": "Update external deployment (authorize)", "operationId": "vcsUpdateExternalDeployments", "tags": [ "vcs" @@ -33751,7 +34754,8 @@ }, "x-appwrite": { "method": "updateExternalDeployments", - "weight": 288, + "group": "repositories", + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -33839,7 +34843,8 @@ }, "x-appwrite": { "method": "listInstallations", - "weight": 285, + "group": "installations", + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -33912,7 +34917,8 @@ }, "x-appwrite": { "method": "getInstallation", - "weight": 286, + "group": "installations", + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -33962,7 +34968,8 @@ }, "x-appwrite": { "method": "deleteInstallation", - "weight": 287, + "group": "installations", + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -34003,90 +35010,71 @@ "tags": [ { "name": "account", - "description": "The Account service allows you to authenticate and manage a user account.", - "x-globalAttributes": [] + "description": "The Account service allows you to authenticate and manage a user account." }, { "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.", - "x-globalAttributes": [] + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." }, { "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents", - "x-globalAttributes": [ - "databaseId" - ] + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" }, { "name": "locale", - "description": "The Locale service allows you to customize your app based on your users' location.", - "x-globalAttributes": [] + "description": "The Locale service allows you to customize your app based on your users' location." }, { "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health.", - "x-globalAttributes": [] + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." }, { "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "storage", - "description": "The Storage service allows you to manage your project files.", - "x-globalAttributes": [] + "description": "The Storage service allows you to manage your project files." }, { "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources", - "x-globalAttributes": [] + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" }, { "name": "users", - "description": "The Users service allows you to manage your project users.", - "x-globalAttributes": [] + "description": "The Users service allows you to manage your project users." }, { "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications.", - "x-globalAttributes": [] + "description": "The Sites Service allows you view, create and manage your web applications." }, { "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions.", - "x-globalAttributes": [] + "description": "The Functions Service allows you view, create and manage your Cloud Functions." }, { "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration.", - "x-globalAttributes": [] + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." }, { "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.", - "x-globalAttributes": [] + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." }, { "name": "console", - "description": "The Console service allows you to interact with console relevant informations.", - "x-globalAttributes": [] + "description": "The Console service allows you to interact with console relevant informations." }, { "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project.", - "x-globalAttributes": [] + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." }, { "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).", - "x-globalAttributes": [] + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." } ], "components": { @@ -34800,6 +35788,30 @@ "keys" ] }, + "devKeyList": { + "description": "Dev Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of devKeys documents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "devKeys": { + "type": "array", + "description": "List of devKeys.", + "items": { + "$ref": "#\/components\/schemas\/devKey" + }, + "x-example": "" + } + }, + "required": [ + "total", + "devKeys" + ] + }, "platformList": { "description": "Platforms List", "type": "object", @@ -36169,6 +37181,15 @@ }, "x-example": [] }, + "lengths": { + "type": "array", + "description": "Index attributes length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, "orders": { "type": "array", "description": "Index orders.", @@ -36195,6 +37216,7 @@ "status", "error", "attributes", + "lengths", "$createdAt", "$updatedAt" ] @@ -37290,29 +38312,35 @@ "description": "Resource ID.", "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" }, - "resourceInternalId": { - "type": "string", - "description": "File ID.", - "x-example": "1:1" - }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "file" + "x-example": "files" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + }, + "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" } }, "required": [ "$id", "$createdAt", "resourceId", - "resourceInternalId", "resourceType", - "expire" + "expire", + "secret", + "accessedAt" ] }, "team": { @@ -39116,6 +40144,14 @@ }, "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", @@ -39299,6 +40335,7 @@ "platforms", "webhooks", "keys", + "devKeys", "smtpEnabled", "smtpSenderName", "smtpSenderEmail", @@ -39489,6 +40526,65 @@ "sdks" ] }, + "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" + ] + }, "mockNumber": { "description": "Mock Number", "type": "object", diff --git a/app/config/specs/open-api3-1.7.x-server.json b/app/config/specs/open-api3-1.7.x-server.json index ca30c5260e8..27b89f81d70 100644 --- a/app/config/specs/open-api3-1.7.x-server.json +++ b/app/config/specs/open-api3-1.7.x-server.json @@ -18,6 +18,9 @@ "servers": [ { "url": "https:\/\/cloud.appwrite.io\/v1" + }, + { + "url": "https:\/\/.cloud.appwrite.io\/v1" } ], "paths": { @@ -43,6 +46,7 @@ }, "x-appwrite": { "method": "get", + "group": "account", "weight": 10, "cookies": false, "type": "", @@ -92,6 +96,7 @@ }, "x-appwrite": { "method": "create", + "group": "account", "weight": 9, "cookies": false, "type": "", @@ -176,6 +181,7 @@ }, "x-appwrite": { "method": "updateEmail", + "group": "account", "weight": 35, "cookies": false, "type": "", @@ -252,6 +258,7 @@ }, "x-appwrite": { "method": "listIdentities", + "group": "identities", "weight": 58, "cookies": false, "type": "", @@ -311,6 +318,7 @@ }, "x-appwrite": { "method": "deleteIdentity", + "group": "identities", "weight": 59, "cookies": false, "type": "", @@ -374,6 +382,7 @@ }, "x-appwrite": { "method": "createJWT", + "group": "tokens", "weight": 30, "cookies": false, "type": "", @@ -422,6 +431,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 32, "cookies": false, "type": "", @@ -488,6 +498,7 @@ }, "x-appwrite": { "method": "updateMFA", + "group": "mfa", "weight": 45, "cookies": false, "type": "", @@ -558,6 +569,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", + "group": "mfa", "weight": 47, "cookies": false, "type": "", @@ -604,7 +616,7 @@ ] }, "put": { - "summary": "Verify authenticator", + "summary": "Update authenticator (confirmation)", "operationId": "accountUpdateMfaAuthenticator", "tags": [ "account" @@ -624,6 +636,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", + "group": "mfa", "weight": 48, "cookies": false, "type": "", @@ -702,6 +715,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", + "group": "mfa", "weight": 52, "cookies": false, "type": "", @@ -770,6 +784,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", + "group": "mfa", "weight": 53, "cookies": false, "type": "", @@ -823,7 +838,7 @@ } }, "put": { - "summary": "Create MFA challenge (confirmation)", + "summary": "Update MFA challenge (confirmation)", "operationId": "accountUpdateMfaChallenge", "tags": [ "account" @@ -843,6 +858,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", + "group": "mfa", "weight": 54, "cookies": false, "type": "", @@ -919,6 +935,7 @@ }, "x-appwrite": { "method": "listMfaFactors", + "group": "mfa", "weight": 46, "cookies": false, "type": "", @@ -950,7 +967,7 @@ }, "\/account\/mfa\/recovery-codes": { "get": { - "summary": "Get MFA recovery codes", + "summary": "List MFA recovery codes", "operationId": "accountGetMfaRecoveryCodes", "tags": [ "account" @@ -970,6 +987,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", + "group": "mfa", "weight": 51, "cookies": false, "type": "", @@ -1019,6 +1037,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", + "group": "mfa", "weight": 49, "cookies": false, "type": "", @@ -1048,7 +1067,7 @@ ] }, "patch": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "accountUpdateMfaRecoveryCodes", "tags": [ "account" @@ -1068,6 +1087,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", + "group": "mfa", "weight": 50, "cookies": false, "type": "", @@ -1119,6 +1139,7 @@ }, "x-appwrite": { "method": "updateName", + "group": "account", "weight": 33, "cookies": false, "type": "", @@ -1189,6 +1210,7 @@ }, "x-appwrite": { "method": "updatePassword", + "group": "account", "weight": 34, "cookies": false, "type": "", @@ -1264,6 +1286,7 @@ }, "x-appwrite": { "method": "updatePhone", + "group": "account", "weight": 36, "cookies": false, "type": "", @@ -1340,6 +1363,7 @@ }, "x-appwrite": { "method": "getPrefs", + "group": "account", "weight": 31, "cookies": false, "type": "", @@ -1389,6 +1413,7 @@ }, "x-appwrite": { "method": "updatePrefs", + "group": "account", "weight": 37, "cookies": false, "type": "", @@ -1459,6 +1484,7 @@ }, "x-appwrite": { "method": "createRecovery", + "group": "recovery", "weight": 39, "cookies": false, "type": "", @@ -1516,7 +1542,7 @@ } }, "put": { - "summary": "Create password recovery (confirmation)", + "summary": "Update password recovery (confirmation)", "operationId": "accountUpdateRecovery", "tags": [ "account" @@ -1536,6 +1562,7 @@ }, "x-appwrite": { "method": "updateRecovery", + "group": "recovery", "weight": 40, "cookies": false, "type": "", @@ -1618,6 +1645,7 @@ }, "x-appwrite": { "method": "listSessions", + "group": "sessions", "weight": 12, "cookies": false, "type": "", @@ -1660,6 +1688,7 @@ }, "x-appwrite": { "method": "deleteSessions", + "group": "sessions", "weight": 13, "cookies": false, "type": "", @@ -1711,6 +1740,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", + "group": "sessions", "weight": 18, "cookies": false, "type": "", @@ -1759,6 +1789,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", + "group": "sessions", "weight": 17, "cookies": false, "type": "", @@ -1832,6 +1863,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", + "group": "sessions", "weight": 27, "cookies": false, "type": "", @@ -1905,6 +1937,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", + "group": "sessions", "weight": 28, "cookies": false, "type": "", @@ -1978,6 +2011,7 @@ }, "x-appwrite": { "method": "createSession", + "group": "sessions", "weight": 19, "cookies": false, "type": "", @@ -2051,6 +2085,7 @@ }, "x-appwrite": { "method": "getSession", + "group": "sessions", "weight": 14, "cookies": false, "type": "", @@ -2112,6 +2147,7 @@ }, "x-appwrite": { "method": "updateSession", + "group": "sessions", "weight": 16, "cookies": false, "type": "", @@ -2166,6 +2202,7 @@ }, "x-appwrite": { "method": "deleteSession", + "group": "sessions", "weight": 15, "cookies": false, "type": "", @@ -2229,6 +2266,7 @@ }, "x-appwrite": { "method": "updateStatus", + "group": "account", "weight": 38, "cookies": false, "type": "", @@ -2280,6 +2318,7 @@ }, "x-appwrite": { "method": "createEmailToken", + "group": "tokens", "weight": 26, "cookies": false, "type": "", @@ -2288,7 +2327,10 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md", "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},email:{param-email}", + "rate-key": [ + "url:{url},email:{param-email}", + "url:{url},ip:{ip}" + ], "scope": "sessions.write", "platforms": [ "server", @@ -2358,6 +2400,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", + "group": "tokens", "weight": 25, "cookies": false, "type": "", @@ -2437,6 +2480,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", + "group": "tokens", "weight": 24, "cookies": false, "type": "webAuth", @@ -2464,7 +2508,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -2484,6 +2528,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2577,6 +2622,7 @@ }, "x-appwrite": { "method": "createPhoneToken", + "group": "tokens", "weight": 29, "cookies": false, "type": "", @@ -2653,6 +2699,7 @@ }, "x-appwrite": { "method": "createVerification", + "group": "verification", "weight": 41, "cookies": false, "type": "", @@ -2701,7 +2748,7 @@ } }, "put": { - "summary": "Create email verification (confirmation)", + "summary": "Update email verification (confirmation)", "operationId": "accountUpdateVerification", "tags": [ "account" @@ -2721,6 +2768,7 @@ }, "x-appwrite": { "method": "updateVerification", + "group": "verification", "weight": 42, "cookies": false, "type": "", @@ -2797,6 +2845,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", + "group": "verification", "weight": 43, "cookies": false, "type": "", @@ -2849,6 +2898,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", + "group": "verification", "weight": 44, "cookies": false, "type": "", @@ -2918,6 +2968,7 @@ }, "x-appwrite": { "method": "getBrowser", + "group": null, "weight": 61, "cookies": false, "type": "location", @@ -3017,13 +3068,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -3045,6 +3096,7 @@ }, "x-appwrite": { "method": "getCreditCard", + "group": null, "weight": 60, "cookies": false, "type": "location", @@ -3150,13 +3202,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -3178,6 +3230,7 @@ }, "x-appwrite": { "method": "getFavicon", + "group": null, "weight": 64, "cookies": false, "type": "location", @@ -3237,6 +3290,7 @@ }, "x-appwrite": { "method": "getFlag", + "group": null, "weight": 62, "cookies": false, "type": "location", @@ -3698,13 +3752,13 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" } @@ -3726,6 +3780,7 @@ }, "x-appwrite": { "method": "getImage", + "group": null, "weight": 63, "cookies": false, "type": "location", @@ -3809,6 +3864,7 @@ }, "x-appwrite": { "method": "getInitials", + "group": null, "weight": 66, "cookies": false, "type": "location", @@ -3902,6 +3958,7 @@ }, "x-appwrite": { "method": "getQR", + "group": null, "weight": 65, "cookies": false, "type": "location", @@ -4002,6 +4059,7 @@ }, "x-appwrite": { "method": "list", + "group": "databases", "weight": 71, "cookies": false, "type": "", @@ -4075,6 +4133,7 @@ }, "x-appwrite": { "method": "create", + "group": "databases", "weight": 70, "cookies": false, "type": "", @@ -4154,6 +4213,7 @@ }, "x-appwrite": { "method": "get", + "group": "databases", "weight": 72, "cookies": false, "type": "", @@ -4213,6 +4273,7 @@ }, "x-appwrite": { "method": "update", + "group": "databases", "weight": 74, "cookies": false, "type": "", @@ -4289,6 +4350,7 @@ }, "x-appwrite": { "method": "delete", + "group": "databases", "weight": 75, "cookies": false, "type": "", @@ -4350,6 +4412,7 @@ }, "x-appwrite": { "method": "listCollections", + "group": "collections", "weight": 77, "cookies": false, "type": "", @@ -4433,6 +4496,7 @@ }, "x-appwrite": { "method": "createCollection", + "group": "collections", "weight": 76, "cookies": false, "type": "", @@ -4537,6 +4601,7 @@ }, "x-appwrite": { "method": "getCollection", + "group": "collections", "weight": 78, "cookies": false, "type": "", @@ -4606,6 +4671,7 @@ }, "x-appwrite": { "method": "updateCollection", + "group": "collections", "weight": 80, "cookies": false, "type": "", @@ -4705,6 +4771,7 @@ }, "x-appwrite": { "method": "deleteCollection", + "group": "collections", "weight": 81, "cookies": false, "type": "", @@ -4776,6 +4843,7 @@ }, "x-appwrite": { "method": "listAttributes", + "group": "attributes", "weight": 92, "cookies": false, "type": "", @@ -4860,6 +4928,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", + "group": "attributes", "weight": 89, "cookies": false, "type": "", @@ -4966,6 +5035,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", + "group": "attributes", "weight": 101, "cookies": false, "type": "", @@ -5077,6 +5147,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", + "group": "attributes", "weight": 90, "cookies": false, "type": "", @@ -5183,6 +5254,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", + "group": "attributes", "weight": 102, "cookies": false, "type": "", @@ -5294,6 +5366,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", + "group": "attributes", "weight": 83, "cookies": false, "type": "", @@ -5400,6 +5473,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", + "group": "attributes", "weight": 95, "cookies": false, "type": "", @@ -5511,6 +5585,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", + "group": "attributes", "weight": 84, "cookies": false, "type": "", @@ -5626,6 +5701,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", + "group": "attributes", "weight": 96, "cookies": false, "type": "", @@ -5746,6 +5822,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", + "group": "attributes", "weight": 88, "cookies": false, "type": "", @@ -5862,6 +5939,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", + "group": "attributes", "weight": 100, "cookies": false, "type": "", @@ -5983,6 +6061,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", + "group": "attributes", "weight": 87, "cookies": false, "type": "", @@ -6099,6 +6178,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", + "group": "attributes", "weight": 99, "cookies": false, "type": "", @@ -6220,6 +6300,7 @@ }, "x-appwrite": { "method": "createIpAttribute", + "group": "attributes", "weight": 85, "cookies": false, "type": "", @@ -6326,6 +6407,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", + "group": "attributes", "weight": 97, "cookies": false, "type": "", @@ -6437,6 +6519,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", + "group": "attributes", "weight": 91, "cookies": false, "type": "", @@ -6568,6 +6651,7 @@ }, "x-appwrite": { "method": "createStringAttribute", + "group": "attributes", "weight": 82, "cookies": false, "type": "", @@ -6685,6 +6769,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", + "group": "attributes", "weight": 94, "cookies": false, "type": "", @@ -6801,6 +6886,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", + "group": "attributes", "weight": 86, "cookies": false, "type": "", @@ -6907,6 +6993,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", + "group": "attributes", "weight": 98, "cookies": false, "type": "", @@ -7049,6 +7136,7 @@ }, "x-appwrite": { "method": "getAttribute", + "group": "attributes", "weight": 93, "cookies": false, "type": "", @@ -7120,6 +7208,7 @@ }, "x-appwrite": { "method": "deleteAttribute", + "group": "attributes", "weight": 104, "cookies": false, "type": "", @@ -7200,6 +7289,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", + "group": "attributes", "weight": 103, "cookies": false, "type": "", @@ -7308,6 +7398,7 @@ }, "x-appwrite": { "method": "listDocuments", + "group": "documents", "weight": 110, "cookies": false, "type": "", @@ -7379,7 +7470,7 @@ "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -7394,6 +7485,7 @@ }, "x-appwrite": { "method": "createDocument", + "group": "documents", "weight": 109, "cookies": false, "type": "", @@ -7410,6 +7502,59 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [], "Session": [] @@ -7468,67 +7613,66 @@ "items": { "type": "string" } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } } - }, - "required": [ - "documentId", - "data" - ] + } } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + }, + "put": { + "summary": "Create or update documents", + "operationId": "databasesUpsertDocuments", "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { "200": { - "description": "Document", + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/documentList" } } } } }, "x-appwrite": { - "method": "getDocument", - "weight": 111, + "method": "upsertDocuments", + "group": "documents", + "weight": 115, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -7544,87 +7688,80 @@ }, { "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", "x-example": "" }, "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + } + } }, "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", "responses": { "200": { - "description": "Document", + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/documentList" } } } } }, "x-appwrite": { - "method": "updateDocument", - "weight": 113, + "method": "updateDocuments", + "group": "documents", + "weight": 114, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/update-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "demo": "databases\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -7647,16 +7784,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -7670,10 +7797,10 @@ "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", "x-example": "{}" }, - "permissions": { + "queries": { "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, "items": { "type": "string" } @@ -7685,46 +7812,50 @@ } }, "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", "tags": [ "databases" ], - "description": "Delete a document by its unique ID.", + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } } }, "x-appwrite": { - "method": "deleteDocument", - "weight": 114, + "method": "deleteDocuments", + "group": "documents", + "weight": 117, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/delete-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "demo": "databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -7747,65 +7878,79 @@ "x-example": "" }, "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + } + } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { "get": { - "summary": "List indexes", - "operationId": "databasesListIndexes", + "summary": "Get document", + "operationId": "databasesGetDocument", "tags": [ "databases" ], - "description": "List indexes in the collection.", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { "200": { - "description": "Indexes List", + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/indexList" + "$ref": "#\/components\/schemas\/document" } } } } }, "x-appwrite": { - "method": "listIndexes", - "weight": 106, + "method": "getDocument", + "group": "documents", + "weight": 111, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/list-indexes.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "demo": "databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "documents.read", "platforms": [ + "client", + "server", "server" ], "packaging": false, "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -7829,9 +7974,19 @@ }, "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", "required": false, "schema": { "type": "array", @@ -7844,17 +7999,287 @@ } ] }, - "post": { - "summary": "Create index", - "operationId": "databasesCreateIndex", + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", "tags": [ "databases" ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { - "202": { - "description": "Index", - "content": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 113, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete document", + "operationId": "databasesDeleteDocument", + "tags": [ + "databases" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 116, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "databasesListIndexes", + "tags": [ + "databases" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/indexList" + } + } + } + } + }, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 106, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "databasesCreateIndex", + "tags": [ + "databases" + ], + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "responses": { + "202": { + "description": "Index", + "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/index" @@ -7865,6 +8290,7 @@ }, "x-appwrite": { "method": "createIndex", + "group": "collections", "weight": 105, "cookies": false, "type": "", @@ -7950,6 +8376,14 @@ "items": { "type": "string" } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } } }, "required": [ @@ -7985,6 +8419,7 @@ }, "x-appwrite": { "method": "getIndex", + "group": "indexes", "weight": 107, "cookies": false, "type": "", @@ -8056,6 +8491,7 @@ }, "x-appwrite": { "method": "deleteIndex", + "group": "indexes", "weight": 108, "cookies": false, "type": "", @@ -8136,7 +8572,8 @@ }, "x-appwrite": { "method": "list", - "weight": 368, + "group": "functions", + "weight": 375, "cookies": false, "type": "", "deprecated": false, @@ -8209,7 +8646,8 @@ }, "x-appwrite": { "method": "create", - "weight": 365, + "group": "functions", + "weight": 372, "cookies": false, "type": "", "deprecated": false, @@ -8440,7 +8878,8 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 370, + "group": "runtimes", + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -8489,7 +8928,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 371, + "group": "runtimes", + "weight": 378, "cookies": false, "type": "", "deprecated": false, @@ -8539,7 +8979,8 @@ }, "x-appwrite": { "method": "get", - "weight": 366, + "group": "functions", + "weight": 373, "cookies": false, "type": "", "deprecated": false, @@ -8598,7 +9039,8 @@ }, "x-appwrite": { "method": "update", - "weight": 367, + "group": "functions", + "weight": 374, "cookies": false, "type": "", "deprecated": false, @@ -8826,7 +9268,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 369, + "group": "functions", + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -8887,7 +9330,8 @@ }, "x-appwrite": { "method": "updateFunctionDeployment", - "weight": 374, + "group": "functions", + "weight": 381, "cookies": false, "type": "", "deprecated": false, @@ -8967,7 +9411,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 375, + "group": "deployments", + "weight": 382, "cookies": false, "type": "", "deprecated": false, @@ -9050,7 +9495,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 372, + "group": "deployments", + "weight": 379, "cookies": false, "type": "upload", "deprecated": false, @@ -9146,7 +9592,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 380, + "group": "deployments", + "weight": 387, "cookies": false, "type": "", "deprecated": false, @@ -9231,7 +9678,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 377, + "group": "deployments", + "weight": 384, "cookies": false, "type": "", "deprecated": false, @@ -9334,7 +9782,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 378, + "group": "deployments", + "weight": 385, "cookies": false, "type": "", "deprecated": false, @@ -9431,7 +9880,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 373, + "group": "deployments", + "weight": 380, "cookies": false, "type": "", "deprecated": false, @@ -9493,7 +9943,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 376, + "group": "deployments", + "weight": 383, "cookies": false, "type": "", "deprecated": false, @@ -9544,7 +9995,7 @@ }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "functionsGetDeploymentDownload", "tags": [ "functions" @@ -9557,7 +10008,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 379, + "group": "deployments", + "weight": 386, "cookies": false, "type": "location", "deprecated": false, @@ -9647,7 +10099,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 381, + "group": "deployments", + "weight": 388, "cookies": false, "type": "", "deprecated": false, @@ -9718,7 +10171,8 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 384, + "group": "executions", + "weight": 391, "cookies": false, "type": "", "deprecated": false, @@ -9794,7 +10248,8 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 382, + "group": "executions", + "weight": 389, "cookies": false, "type": "", "deprecated": false, @@ -9910,7 +10365,8 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 383, + "group": "executions", + "weight": 390, "cookies": false, "type": "", "deprecated": false, @@ -9976,7 +10432,8 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 385, + "group": "executions", + "weight": 392, "cookies": false, "type": "", "deprecated": false, @@ -10047,7 +10504,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 390, + "group": "variables", + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -10106,7 +10564,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 388, + "group": "variables", + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -10197,7 +10656,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 389, + "group": "variables", + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -10266,7 +10726,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 391, + "group": "variables", + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -10357,7 +10818,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 392, + "group": "variables", + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -10428,7 +10890,8 @@ }, "x-appwrite": { "method": "query", - "weight": 303, + "group": "graphql", + "weight": 305, "cookies": false, "type": "graphql", "deprecated": false, @@ -10481,7 +10944,8 @@ }, "x-appwrite": { "method": "mutation", - "weight": 302, + "group": "graphql", + "weight": 304, "cookies": false, "type": "graphql", "deprecated": false, @@ -10534,7 +10998,8 @@ }, "x-appwrite": { "method": "get", - "weight": 126, + "group": "health", + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -10583,7 +11048,8 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 148, + "group": "health", + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -10632,7 +11098,8 @@ }, "x-appwrite": { "method": "getCache", - "weight": 129, + "group": "health", + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -10681,7 +11148,8 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 134, + "group": "health", + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -10741,7 +11209,8 @@ }, "x-appwrite": { "method": "getDB", - "weight": 128, + "group": "health", + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -10790,7 +11259,8 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 130, + "group": "health", + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -10839,7 +11309,8 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 136, + "group": "queue", + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -10901,7 +11372,8 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 135, + "group": "queue", + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -10963,7 +11435,8 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 137, + "group": "queue", + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -11036,7 +11509,8 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 138, + "group": "queue", + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -11098,7 +11572,8 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 149, + "group": "queue", + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -11139,7 +11614,6 @@ "v1-functions", "v1-stats-resources", "v1-stats-usage", - "v1-stats-usage-dump", "v1-webhooks", "v1-certificates", "v1-builds", @@ -11187,7 +11661,8 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 142, + "group": "queue", + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -11249,7 +11724,8 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 133, + "group": "queue", + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -11311,7 +11787,8 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 139, + "group": "queue", + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -11373,7 +11850,8 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 140, + "group": "queue", + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -11435,7 +11913,8 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 141, + "group": "queue", + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -11497,7 +11976,8 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 143, + "group": "queue", + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -11559,7 +12039,8 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 144, + "group": "queue", + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -11599,68 +12080,6 @@ ] } }, - "\/health\/queue\/stats-usage-dump": { - "get": { - "summary": "Get usage dump queue", - "operationId": "healthGetQueueStatsUsageDump", - "tags": [ - "health" - ], - "description": "Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.", - "responses": { - "200": { - "description": "Health Queue", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/healthQueue" - } - } - } - } - }, - "x-appwrite": { - "method": "getQueueStatsUsageDump", - "weight": 145, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "health\/get-queue-stats-usage-dump.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-usage-dump.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "health.read", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "threshold", - "description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 5000 - }, - "in": "query" - } - ] - } - }, "\/health\/queue\/webhooks": { "get": { "summary": "Get webhooks queue", @@ -11683,7 +12102,8 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 132, + "group": "queue", + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -11745,7 +12165,8 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 147, + "group": "storage", + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -11794,7 +12215,8 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 146, + "group": "storage", + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -11843,7 +12265,8 @@ }, "x-appwrite": { "method": "getTime", - "weight": 131, + "group": "health", + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -11892,7 +12315,8 @@ }, "x-appwrite": { "method": "get", - "weight": 118, + "group": null, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -11945,7 +12369,8 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 119, + "group": null, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -11998,7 +12423,8 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 123, + "group": null, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -12051,7 +12477,8 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 120, + "group": null, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -12104,7 +12531,8 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 121, + "group": null, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -12157,7 +12585,8 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 122, + "group": null, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -12210,7 +12639,8 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 124, + "group": null, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -12263,7 +12693,8 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 125, + "group": null, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -12316,7 +12747,8 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 357, + "group": "messages", + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -12392,7 +12824,8 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 354, + "group": "messages", + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -12536,7 +12969,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 361, + "group": "messages", + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -12682,7 +13116,8 @@ }, "x-appwrite": { "method": "createPush", - "weight": 356, + "group": "messages", + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -12856,7 +13291,8 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 363, + "group": "messages", + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -13034,7 +13470,8 @@ }, "x-appwrite": { "method": "createSms", - "weight": 355, + "group": "messages", + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -13143,7 +13580,8 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 362, + "group": "messages", + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -13255,7 +13693,8 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 360, + "group": "messages", + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -13308,7 +13747,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 364, + "group": "messages", + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -13370,7 +13810,8 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 358, + "group": "logs", + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -13445,7 +13886,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 359, + "group": "messages", + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -13520,7 +13962,8 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 329, + "group": "providers", + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -13596,7 +14039,8 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 328, + "group": "providers", + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -13701,7 +14145,8 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 341, + "group": "providers", + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -13809,7 +14254,8 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 327, + "group": "providers", + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -13894,7 +14340,8 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 340, + "group": "providers", + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -13982,7 +14429,8 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 319, + "group": "providers", + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -14097,7 +14545,8 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 332, + "group": "providers", + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -14215,7 +14664,8 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 322, + "group": "providers", + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -14310,7 +14760,8 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 335, + "group": "providers", + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -14408,7 +14859,8 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 320, + "group": "providers", + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -14513,7 +14965,8 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 333, + "group": "providers", + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -14621,7 +15074,8 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 321, + "group": "providers", + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -14764,7 +15218,8 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 334, + "group": "providers", + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -14909,7 +15364,8 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 323, + "group": "providers", + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -15004,7 +15460,8 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 336, + "group": "providers", + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -15102,7 +15559,8 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 324, + "group": "providers", + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -15197,7 +15655,8 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 337, + "group": "providers", + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -15295,7 +15754,8 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 325, + "group": "providers", + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -15390,7 +15850,8 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 338, + "group": "providers", + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -15488,7 +15949,8 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 326, + "group": "providers", + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -15583,7 +16045,8 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 339, + "group": "providers", + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -15681,7 +16144,8 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 331, + "group": "providers", + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -15734,7 +16198,8 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 342, + "group": "providers", + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -15796,7 +16261,8 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 330, + "group": "providers", + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -15871,7 +16337,8 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 351, + "group": "subscribers", + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -15946,7 +16413,8 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 344, + "group": "topics", + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -16020,7 +16488,8 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 343, + "group": "topics", + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -16103,7 +16572,8 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 346, + "group": "topics", + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -16163,7 +16633,8 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 347, + "group": "topics", + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -16240,7 +16711,8 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 348, + "group": "topics", + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -16302,7 +16774,8 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 345, + "group": "topics", + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -16377,7 +16850,8 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 350, + "group": "subscribers", + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -16461,7 +16935,8 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 349, + "group": "subscribers", + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -16552,7 +17027,8 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 352, + "group": "subscribers", + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -16615,7 +17091,8 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 353, + "group": "subscribers", + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -16691,7 +17168,8 @@ }, "x-appwrite": { "method": "list", - "weight": 397, + "group": "sites", + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -16761,7 +17239,8 @@ }, "x-appwrite": { "method": "create", - "weight": 395, + "group": "sites", + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -16818,6 +17297,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -17007,7 +17487,8 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 400, + "group": "frameworks", + "weight": 407, "cookies": false, "type": "", "deprecated": false, @@ -17056,7 +17537,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 423, + "group": "frameworks", + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -17106,7 +17588,8 @@ }, "x-appwrite": { "method": "get", - "weight": 396, + "group": "sites", + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -17165,7 +17648,8 @@ }, "x-appwrite": { "method": "update", - "weight": 398, + "group": "sites", + "weight": 405, "cookies": false, "type": "", "deprecated": false, @@ -17229,6 +17713,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -17407,7 +17892,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 399, + "group": "sites", + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -17468,7 +17954,8 @@ }, "x-appwrite": { "method": "updateSiteDeployment", - "weight": 406, + "group": "sites", + "weight": 413, "cookies": false, "type": "", "deprecated": false, @@ -17548,7 +18035,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 405, + "group": "deployments", + "weight": 412, "cookies": false, "type": "", "deprecated": false, @@ -17631,7 +18119,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 401, + "group": "deployments", + "weight": 408, "cookies": false, "type": "upload", "deprecated": false, @@ -17732,7 +18221,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 409, + "group": "deployments", + "weight": 416, "cookies": false, "type": "", "deprecated": false, @@ -17812,7 +18302,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 402, + "group": "deployments", + "weight": 409, "cookies": false, "type": "", "deprecated": false, @@ -17915,7 +18406,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 403, + "group": "deployments", + "weight": 410, "cookies": false, "type": "", "deprecated": false, @@ -18013,7 +18505,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 404, + "group": "deployments", + "weight": 411, "cookies": false, "type": "", "deprecated": false, @@ -18075,7 +18568,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 407, + "group": "deployments", + "weight": 414, "cookies": false, "type": "", "deprecated": false, @@ -18126,7 +18620,7 @@ }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "sitesGetDeploymentDownload", "tags": [ "sites" @@ -18139,7 +18633,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 408, + "group": "deployments", + "weight": 415, "cookies": false, "type": "location", "deprecated": false, @@ -18229,7 +18724,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 410, + "group": "deployments", + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -18300,7 +18796,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 412, + "group": "logs", + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -18371,7 +18868,8 @@ }, "x-appwrite": { "method": "getLog", - "weight": 411, + "group": "logs", + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -18433,7 +18931,8 @@ }, "x-appwrite": { "method": "deleteLog", - "weight": 413, + "group": "logs", + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -18504,7 +19003,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 416, + "group": "variables", + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -18563,7 +19063,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 414, + "group": "variables", + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -18654,7 +19155,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 415, + "group": "variables", + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -18723,7 +19225,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 417, + "group": "variables", + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -18814,7 +19317,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 418, + "group": "variables", + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -18885,7 +19389,8 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 204, + "group": "buckets", + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -18958,7 +19463,8 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 203, + "group": "buckets", + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -19085,7 +19591,8 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 205, + "group": "buckets", + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -19144,7 +19651,8 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 206, + "group": "buckets", + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -19268,7 +19776,8 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 207, + "group": "buckets", + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -19329,7 +19838,8 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 209, + "group": "files", + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -19416,7 +19926,8 @@ }, "x-appwrite": { "method": "createFile", - "weight": 208, + "group": "files", + "weight": 210, "cookies": false, "type": "upload", "deprecated": false, @@ -19515,7 +20026,8 @@ }, "x-appwrite": { "method": "getFile", - "weight": 210, + "group": "files", + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -19588,7 +20100,8 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 215, + "group": "files", + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -19678,7 +20191,8 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 216, + "group": "files", + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -19746,7 +20260,8 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 212, + "group": "files", + "weight": 214, "cookies": false, "type": "location", "deprecated": false, @@ -19795,6 +20310,17 @@ "x-example": "" }, "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -19814,7 +20340,8 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 211, + "group": "files", + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -19914,13 +20441,13 @@ }, { "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "schema": { "type": "integer", "format": "int32", - "x-example": 0, - "default": 100 + "x-example": -1, + "default": -1 }, "in": "query" }, @@ -20013,6 +20540,17 @@ "default": "" }, "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -20032,7 +20570,8 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 213, + "group": "files", + "weight": 215, "cookies": false, "type": "location", "deprecated": false, @@ -20081,6 +20620,17 @@ "x-example": "" }, "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } @@ -20107,7 +20657,8 @@ }, "x-appwrite": { "method": "list", - "weight": 220, + "group": "teams", + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -20184,7 +20735,8 @@ }, "x-appwrite": { "method": "create", - "weight": 219, + "group": "teams", + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -20270,7 +20822,8 @@ }, "x-appwrite": { "method": "get", - "weight": 221, + "group": "teams", + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -20333,7 +20886,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 223, + "group": "teams", + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -20408,7 +20962,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 225, + "group": "teams", + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -20473,7 +21028,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 227, + "group": "memberships", + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -20560,7 +21116,8 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 226, + "group": "memberships", + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -20672,7 +21229,8 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 228, + "group": "memberships", + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -20745,7 +21303,8 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 229, + "group": "memberships", + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -20833,7 +21392,8 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 231, + "group": "memberships", + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -20908,7 +21468,8 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 230, + "group": "memberships", + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -21006,7 +21567,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 222, + "group": "teams", + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -21067,7 +21629,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 224, + "group": "teams", + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -21149,7 +21712,8 @@ }, "x-appwrite": { "method": "list", - "weight": 432, + "group": "files", + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -21160,22 +21724,19 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21217,7 +21778,7 @@ "tags": [ "tokens" ], - "description": "Create a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "description": "Create a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "responses": { "201": { "description": "ResourceToken", @@ -21232,33 +21793,31 @@ }, "x-appwrite": { "method": "createFileToken", - "weight": 429, + "group": "files", + "weight": 436, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/create-file-token.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21294,14 +21853,6 @@ "description": "Token expiry date", "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -21332,7 +21883,8 @@ }, "x-appwrite": { "method": "get", - "weight": 430, + "group": "tokens", + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -21343,22 +21895,19 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21380,7 +21929,7 @@ "tags": [ "tokens" ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { "200": { "description": "ResourceToken", @@ -21395,33 +21944,31 @@ }, "x-appwrite": { "method": "update", - "weight": 433, + "group": "tokens", + "weight": 439, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/update.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21447,14 +21994,6 @@ "description": "File token expiry date", "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -21476,7 +22015,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 434, + "group": "tokens", + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -21487,22 +22027,19 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21519,71 +22056,6 @@ ] } }, - "\/tokens\/{tokenId}\/jwt": { - "get": { - "summary": "Get token as JWT", - "operationId": "tokensGetJWT", - "tags": [ - "tokens" - ], - "description": "Get a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "responses": { - "200": { - "description": "JWT", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/jwt" - } - } - } - } - }, - "x-appwrite": { - "method": "getJWT", - "weight": 431, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get-j-w-t.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "File token ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, "\/users": { "get": { "summary": "List users", @@ -21606,7 +22078,8 @@ }, "x-appwrite": { "method": "list", - "weight": 242, + "group": "users", + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -21679,7 +22152,8 @@ }, "x-appwrite": { "method": "create", - "weight": 233, + "group": "users", + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -21767,7 +22241,8 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 236, + "group": "users", + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -21852,7 +22327,8 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 234, + "group": "users", + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -21937,7 +22413,8 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 250, + "group": "identities", + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -22005,7 +22482,8 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 273, + "group": "identities", + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -22066,7 +22544,8 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 235, + "group": "users", + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -22151,7 +22630,8 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 238, + "group": "users", + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -22236,7 +22716,8 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 239, + "group": "users", + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -22351,7 +22832,8 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 240, + "group": "users", + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -22454,7 +22936,8 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 237, + "group": "users", + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -22559,7 +23042,8 @@ }, "x-appwrite": { "method": "get", - "weight": 243, + "group": "users", + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -22611,7 +23095,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 271, + "group": "users", + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -22672,7 +23157,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 256, + "group": "users", + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -22752,7 +23238,8 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 274, + "group": "sessions", + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -22834,7 +23321,8 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 252, + "group": "users", + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -22917,7 +23405,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 248, + "group": "logs", + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -22991,7 +23480,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 247, + "group": "memberships", + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -23076,7 +23566,8 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 261, + "group": "users", + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -23149,7 +23640,8 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 266, + "group": "mfa", + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -23225,7 +23717,8 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 262, + "group": "mfa", + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -23286,7 +23779,8 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 263, + "group": "mfa", + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -23325,7 +23819,7 @@ ] }, "put": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "usersUpdateMfaRecoveryCodes", "tags": [ "users" @@ -23345,7 +23839,8 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 265, + "group": "mfa", + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -23404,7 +23899,8 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 264, + "group": "mfa", + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -23465,7 +23961,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 254, + "group": "users", + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -23545,7 +24042,8 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 255, + "group": "users", + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -23625,7 +24123,8 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 257, + "group": "users", + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -23705,7 +24204,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 244, + "group": "users", + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -23764,7 +24264,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 259, + "group": "users", + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -23844,7 +24345,8 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 246, + "group": "sessions", + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -23903,7 +24405,8 @@ }, "x-appwrite": { "method": "createSession", - "weight": 267, + "group": "sessions", + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -23955,7 +24458,8 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 270, + "group": "sessions", + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -24009,7 +24513,8 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 269, + "group": "sessions", + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -24080,7 +24585,8 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 251, + "group": "users", + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -24160,7 +24666,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 249, + "group": "targets", + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -24233,7 +24740,8 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 241, + "group": "targets", + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -24343,7 +24851,8 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 245, + "group": "targets", + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -24413,7 +24922,8 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 260, + "group": "targets", + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -24502,7 +25012,8 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 272, + "group": "targets", + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -24574,7 +25085,8 @@ }, "x-appwrite": { "method": "createToken", - "weight": 268, + "group": "sessions", + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -24656,7 +25168,8 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 258, + "group": "users", + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -24736,7 +25249,8 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 253, + "group": "users", + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -24798,90 +25312,71 @@ "tags": [ { "name": "account", - "description": "The Account service allows you to authenticate and manage a user account.", - "x-globalAttributes": [] + "description": "The Account service allows you to authenticate and manage a user account." }, { "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.", - "x-globalAttributes": [] + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." }, { "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents", - "x-globalAttributes": [ - "databaseId" - ] + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" }, { "name": "locale", - "description": "The Locale service allows you to customize your app based on your users' location.", - "x-globalAttributes": [] + "description": "The Locale service allows you to customize your app based on your users' location." }, { "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health.", - "x-globalAttributes": [] + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." }, { "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "storage", - "description": "The Storage service allows you to manage your project files.", - "x-globalAttributes": [] + "description": "The Storage service allows you to manage your project files." }, { "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources", - "x-globalAttributes": [] + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" }, { "name": "users", - "description": "The Users service allows you to manage your project users.", - "x-globalAttributes": [] + "description": "The Users service allows you to manage your project users." }, { "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications.", - "x-globalAttributes": [] + "description": "The Sites Service allows you view, create and manage your web applications." }, { "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions.", - "x-globalAttributes": [] + "description": "The Functions Service allows you view, create and manage your Cloud Functions." }, { "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration.", - "x-globalAttributes": [] + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." }, { "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.", - "x-globalAttributes": [] + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." }, { "name": "console", - "description": "The Console service allows you to interact with console relevant informations.", - "x-globalAttributes": [] + "description": "The Console service allows you to interact with console relevant informations." }, { "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project.", - "x-globalAttributes": [] + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." }, { "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).", - "x-globalAttributes": [] + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." } ], "components": { @@ -26652,6 +27147,15 @@ }, "x-example": [] }, + "lengths": { + "type": "array", + "description": "Index attributes length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, "orders": { "type": "array", "description": "Index orders.", @@ -26678,6 +27182,7 @@ "status", "error", "attributes", + "lengths", "$createdAt", "$updatedAt" ] @@ -27773,29 +28278,35 @@ "description": "Resource ID.", "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" }, - "resourceInternalId": { - "type": "string", - "description": "File ID.", - "x-example": "1:1" - }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "file" + "x-example": "files" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + }, + "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" } }, "required": [ "$id", "$createdAt", "resourceId", - "resourceInternalId", "resourceType", - "expire" + "expire", + "secret", + "accessedAt" ] }, "team": { diff --git a/app/config/specs/open-api3-latest-client.json b/app/config/specs/open-api3-latest-client.json index 528645eaca0..d11a6482223 100644 --- a/app/config/specs/open-api3-latest-client.json +++ b/app/config/specs/open-api3-latest-client.json @@ -4465,6 +4465,11 @@ "methods": [ { "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, "parameters": [ "databaseId", "collectionId", @@ -4485,6 +4490,29 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." } ], "auth": { diff --git a/app/config/specs/open-api3-latest-console.json b/app/config/specs/open-api3-latest-console.json index 66d90ce15f9..5e1d6f345d8 100644 --- a/app/config/specs/open-api3-latest-console.json +++ b/app/config/specs/open-api3-latest-console.json @@ -8024,6 +8024,11 @@ "methods": [ { "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, "parameters": [ "databaseId", "collectionId", @@ -8044,6 +8049,29 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." } ], "auth": { diff --git a/app/config/specs/open-api3-latest-server.json b/app/config/specs/open-api3-latest-server.json index 44b9c4be427..27b89f81d70 100644 --- a/app/config/specs/open-api3-latest-server.json +++ b/app/config/specs/open-api3-latest-server.json @@ -7505,6 +7505,11 @@ "methods": [ { "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, "parameters": [ "databaseId", "collectionId", @@ -7525,6 +7530,29 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." } ], "auth": { diff --git a/app/config/specs/swagger2-1.7.x-client.json b/app/config/specs/swagger2-1.7.x-client.json index 0dd88e6d4f0..35b2f8bce74 100644 --- a/app/config/specs/swagger2-1.7.x-client.json +++ b/app/config/specs/swagger2-1.7.x-client.json @@ -16,6 +16,7 @@ } }, "host": "cloud.appwrite.io", + "x-host-docs": ".cloud.appwrite.io", "basePath": "\/v1", "schemes": [ "https" @@ -67,9 +68,7 @@ "get": { "summary": "Get account", "operationId": "accountGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -87,6 +86,7 @@ }, "x-appwrite": { "method": "get", + "group": "account", "weight": 10, "cookies": false, "type": "", @@ -137,6 +137,7 @@ }, "x-appwrite": { "method": "create", + "group": "account", "weight": 9, "cookies": false, "type": "", @@ -227,6 +228,7 @@ }, "x-appwrite": { "method": "updateEmail", + "group": "account", "weight": 35, "cookies": false, "type": "", @@ -286,9 +288,7 @@ "get": { "summary": "List identities", "operationId": "accountListIdentities", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -306,6 +306,7 @@ }, "x-appwrite": { "method": "listIdentities", + "group": "identities", "weight": 58, "cookies": false, "type": "", @@ -367,6 +368,7 @@ }, "x-appwrite": { "method": "deleteIdentity", + "group": "identities", "weight": 59, "cookies": false, "type": "", @@ -429,6 +431,7 @@ }, "x-appwrite": { "method": "createJWT", + "group": "tokens", "weight": 30, "cookies": false, "type": "", @@ -459,9 +462,7 @@ "get": { "summary": "List logs", "operationId": "accountListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -479,6 +480,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 32, "cookies": false, "type": "", @@ -545,6 +547,7 @@ }, "x-appwrite": { "method": "updateMFA", + "group": "mfa", "weight": 45, "cookies": false, "type": "", @@ -617,6 +620,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", + "group": "mfa", "weight": 47, "cookies": false, "type": "", @@ -660,7 +664,7 @@ ] }, "put": { - "summary": "Verify authenticator", + "summary": "Update authenticator (confirmation)", "operationId": "accountUpdateMfaAuthenticator", "consumes": [ "application\/json" @@ -682,6 +686,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", + "group": "mfa", "weight": 48, "cookies": false, "type": "", @@ -760,6 +765,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", + "group": "mfa", "weight": 52, "cookies": false, "type": "", @@ -827,6 +833,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", + "group": "mfa", "weight": 53, "cookies": false, "type": "", @@ -881,7 +888,7 @@ ] }, "put": { - "summary": "Create MFA challenge (confirmation)", + "summary": "Update MFA challenge (confirmation)", "operationId": "accountUpdateMfaChallenge", "consumes": [ "application\/json" @@ -903,6 +910,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", + "group": "mfa", "weight": 54, "cookies": false, "type": "", @@ -962,9 +970,7 @@ "get": { "summary": "List factors", "operationId": "accountListMfaFactors", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -982,6 +988,7 @@ }, "x-appwrite": { "method": "listMfaFactors", + "group": "mfa", "weight": 46, "cookies": false, "type": "", @@ -1012,11 +1019,9 @@ }, "\/account\/mfa\/recovery-codes": { "get": { - "summary": "Get MFA recovery codes", + "summary": "List MFA recovery codes", "operationId": "accountGetMfaRecoveryCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1034,6 +1039,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", + "group": "mfa", "weight": 51, "cookies": false, "type": "", @@ -1084,6 +1090,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", + "group": "mfa", "weight": 49, "cookies": false, "type": "", @@ -1112,7 +1119,7 @@ ] }, "patch": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "accountUpdateMfaRecoveryCodes", "consumes": [ "application\/json" @@ -1134,6 +1141,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", + "group": "mfa", "weight": 50, "cookies": false, "type": "", @@ -1186,6 +1194,7 @@ }, "x-appwrite": { "method": "updateName", + "group": "account", "weight": 33, "cookies": false, "type": "", @@ -1258,6 +1267,7 @@ }, "x-appwrite": { "method": "updatePassword", + "group": "account", "weight": 34, "cookies": false, "type": "", @@ -1336,6 +1346,7 @@ }, "x-appwrite": { "method": "updatePhone", + "group": "account", "weight": 36, "cookies": false, "type": "", @@ -1395,9 +1406,7 @@ "get": { "summary": "Get account preferences", "operationId": "accountGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1415,6 +1424,7 @@ }, "x-appwrite": { "method": "getPrefs", + "group": "account", "weight": 31, "cookies": false, "type": "", @@ -1465,6 +1475,7 @@ }, "x-appwrite": { "method": "updatePrefs", + "group": "account", "weight": 37, "cookies": false, "type": "", @@ -1537,6 +1548,7 @@ }, "x-appwrite": { "method": "createRecovery", + "group": "recovery", "weight": 39, "cookies": false, "type": "", @@ -1595,7 +1607,7 @@ ] }, "put": { - "summary": "Create password recovery (confirmation)", + "summary": "Update password recovery (confirmation)", "operationId": "accountUpdateRecovery", "consumes": [ "application\/json" @@ -1617,6 +1629,7 @@ }, "x-appwrite": { "method": "updateRecovery", + "group": "recovery", "weight": 40, "cookies": false, "type": "", @@ -1683,9 +1696,7 @@ "get": { "summary": "List sessions", "operationId": "accountListSessions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1703,6 +1714,7 @@ }, "x-appwrite": { "method": "listSessions", + "group": "sessions", "weight": 12, "cookies": false, "type": "", @@ -1748,6 +1760,7 @@ }, "x-appwrite": { "method": "deleteSessions", + "group": "sessions", "weight": 13, "cookies": false, "type": "", @@ -1800,6 +1813,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", + "group": "sessions", "weight": 18, "cookies": false, "type": "", @@ -1850,6 +1864,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", + "group": "sessions", "weight": 17, "cookies": false, "type": "", @@ -1927,6 +1942,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", + "group": "sessions", "weight": 27, "cookies": false, "type": "", @@ -1984,9 +2000,7 @@ "get": { "summary": "Create OAuth2 session", "operationId": "accountCreateOAuth2Session", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "text\/html" ], @@ -2001,6 +2015,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", + "group": "sessions", "weight": 20, "cookies": false, "type": "webAuth", @@ -2028,7 +2043,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -2047,6 +2062,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2136,6 +2152,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", + "group": "sessions", "weight": 28, "cookies": false, "type": "", @@ -2213,6 +2230,7 @@ }, "x-appwrite": { "method": "createSession", + "group": "sessions", "weight": 19, "cookies": false, "type": "", @@ -2270,9 +2288,7 @@ "get": { "summary": "Get session", "operationId": "accountGetSession", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -2290,6 +2306,7 @@ }, "x-appwrite": { "method": "getSession", + "group": "sessions", "weight": 14, "cookies": false, "type": "", @@ -2350,6 +2367,7 @@ }, "x-appwrite": { "method": "updateSession", + "group": "sessions", "weight": 16, "cookies": false, "type": "", @@ -2405,6 +2423,7 @@ }, "x-appwrite": { "method": "deleteSession", + "group": "sessions", "weight": 15, "cookies": false, "type": "", @@ -2467,6 +2486,7 @@ }, "x-appwrite": { "method": "updateStatus", + "group": "account", "weight": 38, "cookies": false, "type": "", @@ -2519,6 +2539,7 @@ }, "x-appwrite": { "method": "createPushTarget", + "group": "pushTargets", "weight": 55, "cookies": false, "type": "", @@ -2602,6 +2623,7 @@ }, "x-appwrite": { "method": "updatePushTarget", + "group": "pushTargets", "weight": 56, "cookies": false, "type": "", @@ -2673,6 +2695,7 @@ }, "x-appwrite": { "method": "deletePushTarget", + "group": "pushTargets", "weight": 57, "cookies": false, "type": "", @@ -2733,6 +2756,7 @@ }, "x-appwrite": { "method": "createEmailToken", + "group": "tokens", "weight": 26, "cookies": false, "type": "", @@ -2741,7 +2765,10 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md", "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},email:{param-email}", + "rate-key": [ + "url:{url},email:{param-email}", + "url:{url},ip:{ip}" + ], "scope": "sessions.write", "platforms": [ "server", @@ -2816,6 +2843,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", + "group": "tokens", "weight": 25, "cookies": false, "type": "", @@ -2888,9 +2916,7 @@ "get": { "summary": "Create OAuth2 token", "operationId": "accountCreateOAuth2Token", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "text\/html" ], @@ -2905,6 +2931,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", + "group": "tokens", "weight": 24, "cookies": false, "type": "webAuth", @@ -2932,7 +2959,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -2951,6 +2978,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -3040,6 +3068,7 @@ }, "x-appwrite": { "method": "createPhoneToken", + "group": "tokens", "weight": 29, "cookies": false, "type": "", @@ -3120,6 +3149,7 @@ }, "x-appwrite": { "method": "createVerification", + "group": "verification", "weight": 41, "cookies": false, "type": "", @@ -3168,7 +3198,7 @@ ] }, "put": { - "summary": "Create email verification (confirmation)", + "summary": "Update email verification (confirmation)", "operationId": "accountUpdateVerification", "consumes": [ "application\/json" @@ -3190,6 +3220,7 @@ }, "x-appwrite": { "method": "updateVerification", + "group": "verification", "weight": 42, "cookies": false, "type": "", @@ -3269,6 +3300,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", + "group": "verification", "weight": 43, "cookies": false, "type": "", @@ -3322,6 +3354,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", + "group": "verification", "weight": 44, "cookies": false, "type": "", @@ -3381,9 +3414,7 @@ "get": { "summary": "Get browser icon", "operationId": "avatarsGetBrowser", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3401,6 +3432,7 @@ }, "x-appwrite": { "method": "getBrowser", + "group": null, "weight": 61, "cookies": false, "type": "location", @@ -3492,12 +3524,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -3507,9 +3539,7 @@ "get": { "summary": "Get credit card icon", "operationId": "avatarsGetCreditCard", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3527,6 +3557,7 @@ }, "x-appwrite": { "method": "getCreditCard", + "group": null, "weight": 60, "cookies": false, "type": "location", @@ -3624,12 +3655,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -3639,9 +3670,7 @@ "get": { "summary": "Get favicon", "operationId": "avatarsGetFavicon", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -3659,6 +3688,7 @@ }, "x-appwrite": { "method": "getFavicon", + "group": null, "weight": 64, "cookies": false, "type": "location", @@ -3703,9 +3733,7 @@ "get": { "summary": "Get country flag", "operationId": "avatarsGetFlag", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3723,6 +3751,7 @@ }, "x-appwrite": { "method": "getFlag", + "group": null, "weight": 62, "cookies": false, "type": "location", @@ -4176,12 +4205,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -4191,9 +4220,7 @@ "get": { "summary": "Get image from URL", "operationId": "avatarsGetImage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -4211,6 +4238,7 @@ }, "x-appwrite": { "method": "getImage", + "group": null, "weight": 63, "cookies": false, "type": "location", @@ -4275,9 +4303,7 @@ "get": { "summary": "Get user initials", "operationId": "avatarsGetInitials", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -4295,6 +4321,7 @@ }, "x-appwrite": { "method": "getInitials", + "group": null, "weight": 66, "cookies": false, "type": "location", @@ -4367,9 +4394,7 @@ "get": { "summary": "Get QR code", "operationId": "avatarsGetQR", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -4387,6 +4412,7 @@ }, "x-appwrite": { "method": "getQR", + "group": null, "weight": 65, "cookies": false, "type": "location", @@ -4459,9 +4485,7 @@ "get": { "summary": "List documents", "operationId": "databasesListDocuments", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4479,6 +4503,7 @@ }, "x-appwrite": { "method": "listDocuments", + "group": "documents", "weight": 110, "cookies": false, "type": "", @@ -4549,7 +4574,7 @@ "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -4560,6 +4585,7 @@ }, "x-appwrite": { "method": "createDocument", + "group": "documents", "weight": 109, "cookies": false, "type": "", @@ -4576,6 +4602,59 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [] } @@ -4613,13 +4692,13 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, + "default": "", "x-example": "" }, "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -4630,12 +4709,17 @@ "items": { "type": "string" } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } - }, - "required": [ - "documentId", - "data" - ] + } } } ] @@ -4645,9 +4729,7 @@ "get": { "summary": "Get document", "operationId": "databasesGetDocument", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4665,6 +4747,7 @@ }, "x-appwrite": { "method": "getDocument", + "group": "documents", "weight": 111, "cookies": false, "type": "", @@ -4754,6 +4837,7 @@ }, "x-appwrite": { "method": "updateDocument", + "group": "documents", "weight": 113, "cookies": false, "type": "", @@ -4850,7 +4934,8 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 114, + "group": "documents", + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -4909,9 +4994,7 @@ "get": { "summary": "List executions", "operationId": "functionsListExecutions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4929,7 +5012,8 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 384, + "group": "executions", + "weight": 391, "cookies": false, "type": "", "deprecated": false, @@ -5002,7 +5086,8 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 382, + "group": "executions", + "weight": 389, "cookies": false, "type": "", "deprecated": false, @@ -5100,9 +5185,7 @@ "get": { "summary": "Get execution", "operationId": "functionsGetExecution", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5120,7 +5203,8 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 383, + "group": "executions", + "weight": 390, "cookies": false, "type": "", "deprecated": false, @@ -5191,7 +5275,8 @@ }, "x-appwrite": { "method": "query", - "weight": 303, + "group": "graphql", + "weight": 305, "cookies": false, "type": "graphql", "deprecated": false, @@ -5264,7 +5349,8 @@ }, "x-appwrite": { "method": "mutation", - "weight": 302, + "group": "graphql", + "weight": 304, "cookies": false, "type": "graphql", "deprecated": false, @@ -5317,9 +5403,7 @@ "get": { "summary": "Get user locale", "operationId": "localeGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5337,7 +5421,8 @@ }, "x-appwrite": { "method": "get", - "weight": 118, + "group": null, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -5370,9 +5455,7 @@ "get": { "summary": "List locale codes", "operationId": "localeListCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5390,7 +5473,8 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 119, + "group": null, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -5423,9 +5507,7 @@ "get": { "summary": "List continents", "operationId": "localeListContinents", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5443,7 +5525,8 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 123, + "group": null, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -5476,9 +5559,7 @@ "get": { "summary": "List countries", "operationId": "localeListCountries", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5496,7 +5577,8 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 120, + "group": null, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -5529,9 +5611,7 @@ "get": { "summary": "List EU countries", "operationId": "localeListCountriesEU", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5549,7 +5629,8 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 121, + "group": null, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -5582,9 +5663,7 @@ "get": { "summary": "List countries phone codes", "operationId": "localeListCountriesPhones", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5602,7 +5681,8 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 122, + "group": null, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -5635,9 +5715,7 @@ "get": { "summary": "List currencies", "operationId": "localeListCurrencies", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5655,7 +5733,8 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 124, + "group": null, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -5688,9 +5767,7 @@ "get": { "summary": "List languages", "operationId": "localeListLanguages", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5708,7 +5785,8 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 125, + "group": null, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -5761,7 +5839,8 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 349, + "group": "subscribers", + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -5845,7 +5924,8 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 353, + "group": "subscribers", + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -5897,9 +5977,7 @@ "get": { "summary": "List files", "operationId": "storageListFiles", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5917,7 +5995,8 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 209, + "group": "files", + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -5999,7 +6078,8 @@ }, "x-appwrite": { "method": "createFile", - "weight": 208, + "group": "files", + "weight": 210, "cookies": false, "type": "upload", "deprecated": false, @@ -6070,9 +6150,7 @@ "get": { "summary": "Get file", "operationId": "storageGetFile", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -6090,7 +6168,8 @@ }, "x-appwrite": { "method": "getFile", - "weight": 210, + "group": "files", + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -6159,7 +6238,8 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 215, + "group": "files", + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -6247,7 +6327,8 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 216, + "group": "files", + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -6298,9 +6379,7 @@ "get": { "summary": "Get file for download", "operationId": "storageGetFileDownload", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -6318,7 +6397,8 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 212, + "group": "files", + "weight": 214, "cookies": false, "type": "location", "deprecated": false, @@ -6361,6 +6441,15 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -6369,9 +6458,7 @@ "get": { "summary": "Get file preview", "operationId": "storageGetFilePreview", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -6389,7 +6476,8 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 211, + "group": "files", + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -6477,12 +6565,12 @@ }, { "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" }, { @@ -6560,6 +6648,15 @@ "x-enum-keys": [], "default": "", "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -6568,9 +6665,7 @@ "get": { "summary": "Get file for view", "operationId": "storageGetFileView", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -6588,7 +6683,8 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 213, + "group": "files", + "weight": 215, "cookies": false, "type": "location", "deprecated": false, @@ -6631,6 +6727,15 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -6639,9 +6744,7 @@ "get": { "summary": "List teams", "operationId": "teamsList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -6659,7 +6762,8 @@ }, "x-appwrite": { "method": "list", - "weight": 220, + "group": "teams", + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -6733,7 +6837,8 @@ }, "x-appwrite": { "method": "create", - "weight": 219, + "group": "teams", + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -6804,9 +6909,7 @@ "get": { "summary": "Get team", "operationId": "teamsGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -6824,7 +6927,8 @@ }, "x-appwrite": { "method": "get", - "weight": 221, + "group": "teams", + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -6885,7 +6989,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 223, + "group": "teams", + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -6959,7 +7064,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 225, + "group": "teams", + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -7002,9 +7108,7 @@ "get": { "summary": "List team memberships", "operationId": "teamsListMemberships", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -7022,7 +7126,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 227, + "group": "memberships", + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -7104,7 +7209,8 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 226, + "group": "memberships", + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -7198,9 +7304,7 @@ "get": { "summary": "Get team membership", "operationId": "teamsGetMembership", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -7218,7 +7322,8 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 228, + "group": "memberships", + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -7287,7 +7392,8 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 229, + "group": "memberships", + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -7372,7 +7478,8 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 231, + "group": "memberships", + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -7443,7 +7550,8 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 230, + "group": "memberships", + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -7518,9 +7626,7 @@ "get": { "summary": "Get team preferences", "operationId": "teamsGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -7538,7 +7644,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 222, + "group": "teams", + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -7598,7 +7705,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 224, + "group": "teams", + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -7653,540 +7761,76 @@ } ] } - }, - "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "List tokens", - "operationId": "tokensList", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tokens" - ], - "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Resource Tokens List", - "schema": { - "$ref": "#\/definitions\/resourceTokenList" - } - } - }, - "x-appwrite": { - "method": "list", - "weight": 432, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/list.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList all the tokens created for a specific file or bucket. You can use the query params to filter your results.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File 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: expire", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - } - ] - }, - "post": { - "summary": "Create file token", - "operationId": "tokensCreateFileToken", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tokens" - ], - "description": "Create a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", - "responses": { - "201": { - "description": "ResourceToken", - "schema": { - "$ref": "#\/definitions\/resourceToken" - } - } - }, - "x-appwrite": { - "method": "createFileToken", - "weight": 429, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/create-file-token.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "expire": { - "type": "string", - "description": "Token expiry date", - "default": null, - "x-example": null, - "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": [], - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - } - } - } - } - ] - } - }, - "\/tokens\/{tokenId}": { - "get": { - "summary": "Get token", - "operationId": "tokensGet", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tokens" - ], - "description": "Get a token by its unique ID.", - "responses": { - "200": { - "description": "ResourceToken", - "schema": { - "$ref": "#\/definitions\/resourceToken" - } - } - }, - "x-appwrite": { - "method": "get", - "weight": 430, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a token by its unique ID.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "Token ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "patch": { - "summary": "Update token", - "operationId": "tokensUpdate", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tokens" - ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", - "responses": { - "200": { - "description": "ResourceToken", - "schema": { - "$ref": "#\/definitions\/resourceToken" - } - } - }, - "x-appwrite": { - "method": "update", - "weight": 433, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/update.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "Token unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "expire": { - "type": "string", - "description": "File token expiry date", - "default": null, - "x-example": null, - "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - } - } - } - } - ] - }, - "delete": { - "summary": "Delete token", - "operationId": "tokensDelete", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "tokens" - ], - "description": "Delete a token by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "x-appwrite": { - "method": "delete", - "weight": 434, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/delete.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a token by its unique ID.", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "Token ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/tokens\/{tokenId}\/jwt": { - "get": { - "summary": "Get token as JWT", - "operationId": "tokensGetJWT", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tokens" - ], - "description": "Get a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "responses": { - "200": { - "description": "JWT", - "schema": { - "$ref": "#\/definitions\/jwt" - } - } - }, - "x-appwrite": { - "method": "getJWT", - "weight": 431, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get-j-w-t.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "File token ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - } - }, - "tags": [ - { - "name": "account", - "description": "The Account service allows you to authenticate and manage a user account.", - "x-globalAttributes": [] + } + }, + "tags": [ + { + "name": "account", + "description": "The Account service allows you to authenticate and manage a user account." }, { "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.", - "x-globalAttributes": [] + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." }, { "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents", - "x-globalAttributes": [ - "databaseId" - ] + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" }, { "name": "locale", - "description": "The Locale service allows you to customize your app based on your users' location.", - "x-globalAttributes": [] + "description": "The Locale service allows you to customize your app based on your users' location." }, { "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health.", - "x-globalAttributes": [] + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." }, { "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "storage", - "description": "The Storage service allows you to manage your project files.", - "x-globalAttributes": [] + "description": "The Storage service allows you to manage your project files." }, { "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources", - "x-globalAttributes": [] + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" }, { "name": "users", - "description": "The Users service allows you to manage your project users.", - "x-globalAttributes": [] + "description": "The Users service allows you to manage your project users." }, { "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications.", - "x-globalAttributes": [] + "description": "The Sites Service allows you view, create and manage your web applications." }, { "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions.", - "x-globalAttributes": [] + "description": "The Functions Service allows you view, create and manage your Cloud Functions." }, { "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration.", - "x-globalAttributes": [] + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." }, { "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.", - "x-globalAttributes": [] + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." }, { "name": "console", - "description": "The Console service allows you to interact with console relevant informations.", - "x-globalAttributes": [] + "description": "The Console service allows you to interact with console relevant informations." }, { "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project.", - "x-globalAttributes": [] + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." }, { "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).", - "x-globalAttributes": [] + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." } ], "definitions": { @@ -8320,31 +7964,6 @@ "files" ] }, - "resourceTokenList": { - "description": "Resource Tokens List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of tokens documents that matched your query.", - "x-example": 5, - "format": "int32" - }, - "tokens": { - "type": "array", - "description": "List of tokens.", - "items": { - "type": "object", - "$ref": "#\/definitions\/resourceToken" - }, - "x-example": "" - } - }, - "required": [ - "total", - "tokens" - ] - }, "teamList": { "description": "Teams List", "type": "object", @@ -9552,50 +9171,6 @@ "chunksUploaded" ] }, - "resourceToken": { - "description": "ResourceToken", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "resourceId": { - "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" - }, - "resourceInternalId": { - "type": "string", - "description": "File ID.", - "x-example": "1:1" - }, - "resourceType": { - "type": "string", - "description": "Resource type.", - "x-example": "file" - }, - "expire": { - "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - } - }, - "required": [ - "$id", - "$createdAt", - "resourceId", - "resourceInternalId", - "resourceType", - "expire" - ] - }, "team": { "description": "Team", "type": "object", diff --git a/app/config/specs/swagger2-1.7.x-console.json b/app/config/specs/swagger2-1.7.x-console.json index 94dad7013c2..749b23ddd54 100644 --- a/app/config/specs/swagger2-1.7.x-console.json +++ b/app/config/specs/swagger2-1.7.x-console.json @@ -16,6 +16,7 @@ } }, "host": "cloud.appwrite.io", + "x-host-docs": ".cloud.appwrite.io", "basePath": "\/v1", "schemes": [ "https" @@ -79,9 +80,7 @@ "get": { "summary": "Get account", "operationId": "accountGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -99,6 +98,7 @@ }, "x-appwrite": { "method": "get", + "group": "account", "weight": 10, "cookies": false, "type": "", @@ -148,6 +148,7 @@ }, "x-appwrite": { "method": "create", + "group": "account", "weight": 9, "cookies": false, "type": "", @@ -231,6 +232,7 @@ }, "x-appwrite": { "method": "delete", + "group": "account", "weight": 11, "cookies": false, "type": "", @@ -280,6 +282,7 @@ }, "x-appwrite": { "method": "updateEmail", + "group": "account", "weight": 35, "cookies": false, "type": "", @@ -338,9 +341,7 @@ "get": { "summary": "List identities", "operationId": "accountListIdentities", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -358,6 +359,7 @@ }, "x-appwrite": { "method": "listIdentities", + "group": "identities", "weight": 58, "cookies": false, "type": "", @@ -418,6 +420,7 @@ }, "x-appwrite": { "method": "deleteIdentity", + "group": "identities", "weight": 59, "cookies": false, "type": "", @@ -479,6 +482,7 @@ }, "x-appwrite": { "method": "createJWT", + "group": "tokens", "weight": 30, "cookies": false, "type": "", @@ -509,9 +513,7 @@ "get": { "summary": "List logs", "operationId": "accountListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -529,6 +531,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 32, "cookies": false, "type": "", @@ -594,6 +597,7 @@ }, "x-appwrite": { "method": "updateMFA", + "group": "mfa", "weight": 45, "cookies": false, "type": "", @@ -665,6 +669,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", + "group": "mfa", "weight": 47, "cookies": false, "type": "", @@ -707,7 +712,7 @@ ] }, "put": { - "summary": "Verify authenticator", + "summary": "Update authenticator (confirmation)", "operationId": "accountUpdateMfaAuthenticator", "consumes": [ "application\/json" @@ -729,6 +734,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", + "group": "mfa", "weight": 48, "cookies": false, "type": "", @@ -806,6 +812,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", + "group": "mfa", "weight": 52, "cookies": false, "type": "", @@ -872,6 +879,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", + "group": "mfa", "weight": 53, "cookies": false, "type": "", @@ -926,7 +934,7 @@ ] }, "put": { - "summary": "Create MFA challenge (confirmation)", + "summary": "Update MFA challenge (confirmation)", "operationId": "accountUpdateMfaChallenge", "consumes": [ "application\/json" @@ -948,6 +956,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", + "group": "mfa", "weight": 54, "cookies": false, "type": "", @@ -1006,9 +1015,7 @@ "get": { "summary": "List factors", "operationId": "accountListMfaFactors", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1026,6 +1033,7 @@ }, "x-appwrite": { "method": "listMfaFactors", + "group": "mfa", "weight": 46, "cookies": false, "type": "", @@ -1055,11 +1063,9 @@ }, "\/account\/mfa\/recovery-codes": { "get": { - "summary": "Get MFA recovery codes", + "summary": "List MFA recovery codes", "operationId": "accountGetMfaRecoveryCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1077,6 +1083,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", + "group": "mfa", "weight": 51, "cookies": false, "type": "", @@ -1126,6 +1133,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", + "group": "mfa", "weight": 49, "cookies": false, "type": "", @@ -1153,7 +1161,7 @@ ] }, "patch": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "accountUpdateMfaRecoveryCodes", "consumes": [ "application\/json" @@ -1175,6 +1183,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", + "group": "mfa", "weight": 50, "cookies": false, "type": "", @@ -1226,6 +1235,7 @@ }, "x-appwrite": { "method": "updateName", + "group": "account", "weight": 33, "cookies": false, "type": "", @@ -1297,6 +1307,7 @@ }, "x-appwrite": { "method": "updatePassword", + "group": "account", "weight": 34, "cookies": false, "type": "", @@ -1374,6 +1385,7 @@ }, "x-appwrite": { "method": "updatePhone", + "group": "account", "weight": 36, "cookies": false, "type": "", @@ -1432,9 +1444,7 @@ "get": { "summary": "Get account preferences", "operationId": "accountGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1452,6 +1462,7 @@ }, "x-appwrite": { "method": "getPrefs", + "group": "account", "weight": 31, "cookies": false, "type": "", @@ -1501,6 +1512,7 @@ }, "x-appwrite": { "method": "updatePrefs", + "group": "account", "weight": 37, "cookies": false, "type": "", @@ -1572,6 +1584,7 @@ }, "x-appwrite": { "method": "createRecovery", + "group": "recovery", "weight": 39, "cookies": false, "type": "", @@ -1629,7 +1642,7 @@ ] }, "put": { - "summary": "Create password recovery (confirmation)", + "summary": "Update password recovery (confirmation)", "operationId": "accountUpdateRecovery", "consumes": [ "application\/json" @@ -1651,6 +1664,7 @@ }, "x-appwrite": { "method": "updateRecovery", + "group": "recovery", "weight": 40, "cookies": false, "type": "", @@ -1716,9 +1730,7 @@ "get": { "summary": "List sessions", "operationId": "accountListSessions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1736,6 +1748,7 @@ }, "x-appwrite": { "method": "listSessions", + "group": "sessions", "weight": 12, "cookies": false, "type": "", @@ -1780,6 +1793,7 @@ }, "x-appwrite": { "method": "deleteSessions", + "group": "sessions", "weight": 13, "cookies": false, "type": "", @@ -1831,6 +1845,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", + "group": "sessions", "weight": 18, "cookies": false, "type": "", @@ -1881,6 +1896,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", + "group": "sessions", "weight": 17, "cookies": false, "type": "", @@ -1958,6 +1974,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", + "group": "sessions", "weight": 27, "cookies": false, "type": "", @@ -2015,9 +2032,7 @@ "get": { "summary": "Create OAuth2 session", "operationId": "accountCreateOAuth2Session", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "text\/html" ], @@ -2032,6 +2047,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", + "group": "sessions", "weight": 20, "cookies": false, "type": "webAuth", @@ -2059,7 +2075,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -2078,6 +2094,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2167,6 +2184,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", + "group": "sessions", "weight": 28, "cookies": false, "type": "", @@ -2244,6 +2262,7 @@ }, "x-appwrite": { "method": "createSession", + "group": "sessions", "weight": 19, "cookies": false, "type": "", @@ -2301,9 +2320,7 @@ "get": { "summary": "Get session", "operationId": "accountGetSession", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -2321,6 +2338,7 @@ }, "x-appwrite": { "method": "getSession", + "group": "sessions", "weight": 14, "cookies": false, "type": "", @@ -2380,6 +2398,7 @@ }, "x-appwrite": { "method": "updateSession", + "group": "sessions", "weight": 16, "cookies": false, "type": "", @@ -2434,6 +2453,7 @@ }, "x-appwrite": { "method": "deleteSession", + "group": "sessions", "weight": 15, "cookies": false, "type": "", @@ -2495,6 +2515,7 @@ }, "x-appwrite": { "method": "updateStatus", + "group": "account", "weight": 38, "cookies": false, "type": "", @@ -2546,6 +2567,7 @@ }, "x-appwrite": { "method": "createPushTarget", + "group": "pushTargets", "weight": 55, "cookies": false, "type": "", @@ -2628,6 +2650,7 @@ }, "x-appwrite": { "method": "updatePushTarget", + "group": "pushTargets", "weight": 56, "cookies": false, "type": "", @@ -2698,6 +2721,7 @@ }, "x-appwrite": { "method": "deletePushTarget", + "group": "pushTargets", "weight": 57, "cookies": false, "type": "", @@ -2757,6 +2781,7 @@ }, "x-appwrite": { "method": "createEmailToken", + "group": "tokens", "weight": 26, "cookies": false, "type": "", @@ -2765,7 +2790,10 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md", "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},email:{param-email}", + "rate-key": [ + "url:{url},email:{param-email}", + "url:{url},ip:{ip}" + ], "scope": "sessions.write", "platforms": [ "server", @@ -2840,6 +2868,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", + "group": "tokens", "weight": 25, "cookies": false, "type": "", @@ -2912,9 +2941,7 @@ "get": { "summary": "Create OAuth2 token", "operationId": "accountCreateOAuth2Token", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "text\/html" ], @@ -2929,6 +2956,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", + "group": "tokens", "weight": 24, "cookies": false, "type": "webAuth", @@ -2956,7 +2984,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -2975,6 +3003,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -3064,6 +3093,7 @@ }, "x-appwrite": { "method": "createPhoneToken", + "group": "tokens", "weight": 29, "cookies": false, "type": "", @@ -3144,6 +3174,7 @@ }, "x-appwrite": { "method": "createVerification", + "group": "verification", "weight": 41, "cookies": false, "type": "", @@ -3191,7 +3222,7 @@ ] }, "put": { - "summary": "Create email verification (confirmation)", + "summary": "Update email verification (confirmation)", "operationId": "accountUpdateVerification", "consumes": [ "application\/json" @@ -3213,6 +3244,7 @@ }, "x-appwrite": { "method": "updateVerification", + "group": "verification", "weight": 42, "cookies": false, "type": "", @@ -3291,6 +3323,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", + "group": "verification", "weight": 43, "cookies": false, "type": "", @@ -3343,6 +3376,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", + "group": "verification", "weight": 44, "cookies": false, "type": "", @@ -3401,9 +3435,7 @@ "get": { "summary": "Get browser icon", "operationId": "avatarsGetBrowser", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3421,6 +3453,7 @@ }, "x-appwrite": { "method": "getBrowser", + "group": null, "weight": 61, "cookies": false, "type": "location", @@ -3512,12 +3545,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -3527,9 +3560,7 @@ "get": { "summary": "Get credit card icon", "operationId": "avatarsGetCreditCard", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3547,6 +3578,7 @@ }, "x-appwrite": { "method": "getCreditCard", + "group": null, "weight": 60, "cookies": false, "type": "location", @@ -3644,12 +3676,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -3659,9 +3691,7 @@ "get": { "summary": "Get favicon", "operationId": "avatarsGetFavicon", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -3679,6 +3709,7 @@ }, "x-appwrite": { "method": "getFavicon", + "group": null, "weight": 64, "cookies": false, "type": "location", @@ -3723,9 +3754,7 @@ "get": { "summary": "Get country flag", "operationId": "avatarsGetFlag", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3743,6 +3772,7 @@ }, "x-appwrite": { "method": "getFlag", + "group": null, "weight": 62, "cookies": false, "type": "location", @@ -4196,12 +4226,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -4211,9 +4241,7 @@ "get": { "summary": "Get image from URL", "operationId": "avatarsGetImage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -4231,6 +4259,7 @@ }, "x-appwrite": { "method": "getImage", + "group": null, "weight": 63, "cookies": false, "type": "location", @@ -4295,9 +4324,7 @@ "get": { "summary": "Get user initials", "operationId": "avatarsGetInitials", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -4315,6 +4342,7 @@ }, "x-appwrite": { "method": "getInitials", + "group": null, "weight": 66, "cookies": false, "type": "location", @@ -4387,9 +4415,7 @@ "get": { "summary": "Get QR code", "operationId": "avatarsGetQR", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -4407,6 +4433,7 @@ }, "x-appwrite": { "method": "getQR", + "group": null, "weight": 65, "cookies": false, "type": "location", @@ -4477,7 +4504,7 @@ }, "\/console\/assistant": { "post": { - "summary": "Ask query", + "summary": "Create assistant query", "operationId": "assistantChat", "consumes": [ "application\/json" @@ -4499,7 +4526,8 @@ }, "x-appwrite": { "method": "chat", - "weight": 305, + "group": "console", + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -4548,9 +4576,7 @@ "get": { "summary": "Check resource ID availability", "operationId": "consoleGetResource", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [], "tags": [ "console" @@ -4563,7 +4589,8 @@ }, "x-appwrite": { "method": "getResource", - "weight": 424, + "group": null, + "weight": 431, "cookies": false, "type": "", "deprecated": false, @@ -4615,9 +4642,7 @@ "get": { "summary": "Get variables", "operationId": "consoleVariables", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4635,7 +4660,8 @@ }, "x-appwrite": { "method": "variables", - "weight": 304, + "group": "console", + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -4664,9 +4690,7 @@ "get": { "summary": "List databases", "operationId": "databasesList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4684,6 +4708,7 @@ }, "x-appwrite": { "method": "list", + "group": "databases", "weight": 71, "cookies": false, "type": "", @@ -4755,6 +4780,7 @@ }, "x-appwrite": { "method": "create", + "group": "databases", "weight": 70, "cookies": false, "type": "", @@ -4818,9 +4844,7 @@ "get": { "summary": "Get databases usage stats", "operationId": "databasesGetUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4838,7 +4862,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 115, + "group": null, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -4889,9 +4914,7 @@ "get": { "summary": "Get database", "operationId": "databasesGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4909,6 +4932,7 @@ }, "x-appwrite": { "method": "get", + "group": "databases", "weight": 72, "cookies": false, "type": "", @@ -4967,6 +4991,7 @@ }, "x-appwrite": { "method": "update", + "group": "databases", "weight": 74, "cookies": false, "type": "", @@ -5044,6 +5069,7 @@ }, "x-appwrite": { "method": "delete", + "group": "databases", "weight": 75, "cookies": false, "type": "", @@ -5084,9 +5110,7 @@ "get": { "summary": "List collections", "operationId": "databasesListCollections", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5104,6 +5128,7 @@ }, "x-appwrite": { "method": "listCollections", + "group": "collections", "weight": 77, "cookies": false, "type": "", @@ -5183,6 +5208,7 @@ }, "x-appwrite": { "method": "createCollection", + "group": "collections", "weight": 76, "cookies": false, "type": "", @@ -5269,9 +5295,7 @@ "get": { "summary": "Get collection", "operationId": "databasesGetCollection", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5289,6 +5313,7 @@ }, "x-appwrite": { "method": "getCollection", + "group": "collections", "weight": 78, "cookies": false, "type": "", @@ -5355,6 +5380,7 @@ }, "x-appwrite": { "method": "updateCollection", + "group": "collections", "weight": 80, "cookies": false, "type": "", @@ -5455,6 +5481,7 @@ }, "x-appwrite": { "method": "deleteCollection", + "group": "collections", "weight": 81, "cookies": false, "type": "", @@ -5503,9 +5530,7 @@ "get": { "summary": "List attributes", "operationId": "databasesListAttributes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -5523,6 +5548,7 @@ }, "x-appwrite": { "method": "listAttributes", + "group": "attributes", "weight": 92, "cookies": false, "type": "", @@ -5603,6 +5629,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", + "group": "attributes", "weight": 89, "cookies": false, "type": "", @@ -5708,6 +5735,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", + "group": "attributes", "weight": 101, "cookies": false, "type": "", @@ -5815,6 +5843,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", + "group": "attributes", "weight": 90, "cookies": false, "type": "", @@ -5920,6 +5949,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", + "group": "attributes", "weight": 102, "cookies": false, "type": "", @@ -6027,6 +6057,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", + "group": "attributes", "weight": 83, "cookies": false, "type": "", @@ -6132,6 +6163,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", + "group": "attributes", "weight": 95, "cookies": false, "type": "", @@ -6239,6 +6271,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", + "group": "attributes", "weight": 84, "cookies": false, "type": "", @@ -6354,6 +6387,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", + "group": "attributes", "weight": 96, "cookies": false, "type": "", @@ -6471,6 +6505,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", + "group": "attributes", "weight": 88, "cookies": false, "type": "", @@ -6588,6 +6623,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", + "group": "attributes", "weight": 100, "cookies": false, "type": "", @@ -6707,6 +6743,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", + "group": "attributes", "weight": 87, "cookies": false, "type": "", @@ -6824,6 +6861,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", + "group": "attributes", "weight": 99, "cookies": false, "type": "", @@ -6943,6 +6981,7 @@ }, "x-appwrite": { "method": "createIpAttribute", + "group": "attributes", "weight": 85, "cookies": false, "type": "", @@ -7048,6 +7087,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", + "group": "attributes", "weight": 97, "cookies": false, "type": "", @@ -7155,6 +7195,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", + "group": "attributes", "weight": 91, "cookies": false, "type": "", @@ -7287,6 +7328,7 @@ }, "x-appwrite": { "method": "createStringAttribute", + "group": "attributes", "weight": 82, "cookies": false, "type": "", @@ -7405,6 +7447,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", + "group": "attributes", "weight": 94, "cookies": false, "type": "", @@ -7518,6 +7561,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", + "group": "attributes", "weight": 86, "cookies": false, "type": "", @@ -7623,6 +7667,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", + "group": "attributes", "weight": 98, "cookies": false, "type": "", @@ -7710,9 +7755,7 @@ "get": { "summary": "Get attribute", "operationId": "databasesGetAttribute", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -7761,6 +7804,7 @@ }, "x-appwrite": { "method": "getAttribute", + "group": "attributes", "weight": 93, "cookies": false, "type": "", @@ -7829,6 +7873,7 @@ }, "x-appwrite": { "method": "deleteAttribute", + "group": "attributes", "weight": 104, "cookies": false, "type": "", @@ -7904,6 +7949,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", + "group": "attributes", "weight": 103, "cookies": false, "type": "", @@ -7987,9 +8033,7 @@ "get": { "summary": "List documents", "operationId": "databasesListDocuments", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8007,6 +8051,7 @@ }, "x-appwrite": { "method": "listDocuments", + "group": "documents", "weight": 110, "cookies": false, "type": "", @@ -8077,7 +8122,7 @@ "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -8088,6 +8133,7 @@ }, "x-appwrite": { "method": "createDocument", + "group": "documents", "weight": 109, "cookies": false, "type": "", @@ -8104,200 +8150,519 @@ "server" ], "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "documentId": { - "type": "string", - "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "default": {}, - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - } + "methods": [ + { + "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], "required": [ + "databaseId", + "collectionId", "documentId", "data" - ] - } - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", - "responses": { - "200": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } - } - }, - "x-appwrite": { - "method": "getDocument", - "weight": 111, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "databases\/get-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." }, - "default": [], - "in": "query" - } - ] - }, - "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", - "responses": { - "200": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." } - } - }, - "x-appwrite": { - "method": "updateDocument", - "weight": 113, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "databases\/update-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "client", - "server", - "server" ], - "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documentId": { + "type": "string", + "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + ] + }, + "put": { + "summary": "Create or update documents", + "operationId": "databasesUpsertDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 115, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + } + } + } + ] + }, + "patch": { + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 114, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 117, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "databasesGetDocument", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 111, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + }, + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 113, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, "auth": { "Project": [] } @@ -8378,7 +8743,8 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 114, + "group": "documents", + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -8437,9 +8803,7 @@ "get": { "summary": "List document logs", "operationId": "databasesListDocumentLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8457,6 +8821,7 @@ }, "x-appwrite": { "method": "listDocumentLogs", + "group": "logs", "weight": 112, "cookies": false, "type": "", @@ -8524,9 +8889,7 @@ "get": { "summary": "List indexes", "operationId": "databasesListIndexes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8544,6 +8907,7 @@ }, "x-appwrite": { "method": "listIndexes", + "group": "indexes", "weight": 106, "cookies": false, "type": "", @@ -8622,6 +8986,7 @@ }, "x-appwrite": { "method": "createIndex", + "group": "collections", "weight": 105, "cookies": false, "type": "", @@ -8705,6 +9070,15 @@ "items": { "type": "string" } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } } }, "required": [ @@ -8721,9 +9095,7 @@ "get": { "summary": "Get index", "operationId": "databasesGetIndex", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8741,6 +9113,7 @@ }, "x-appwrite": { "method": "getIndex", + "group": "indexes", "weight": 107, "cookies": false, "type": "", @@ -8809,6 +9182,7 @@ }, "x-appwrite": { "method": "deleteIndex", + "group": "indexes", "weight": 108, "cookies": false, "type": "", @@ -8864,9 +9238,7 @@ "get": { "summary": "List collection logs", "operationId": "databasesListCollectionLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8884,6 +9256,7 @@ }, "x-appwrite": { "method": "listCollectionLogs", + "group": "collections", "weight": 79, "cookies": false, "type": "", @@ -8943,9 +9316,7 @@ "get": { "summary": "Get collection usage stats", "operationId": "databasesGetCollectionUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8963,7 +9334,8 @@ }, "x-appwrite": { "method": "getCollectionUsage", - "weight": 117, + "group": null, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -9030,9 +9402,7 @@ "get": { "summary": "List database logs", "operationId": "databasesListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9050,6 +9420,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 73, "cookies": false, "type": "", @@ -9101,9 +9472,7 @@ "get": { "summary": "Get database usage stats", "operationId": "databasesGetDatabaseUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9121,7 +9490,8 @@ }, "x-appwrite": { "method": "getDatabaseUsage", - "weight": 116, + "group": null, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -9180,9 +9550,7 @@ "get": { "summary": "List functions", "operationId": "functionsList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9200,7 +9568,8 @@ }, "x-appwrite": { "method": "list", - "weight": 368, + "group": "functions", + "weight": 375, "cookies": false, "type": "", "deprecated": false, @@ -9271,7 +9640,8 @@ }, "x-appwrite": { "method": "create", - "weight": 365, + "group": "functions", + "weight": 372, "cookies": false, "type": "", "deprecated": false, @@ -9501,9 +9871,7 @@ "get": { "summary": "List runtimes", "operationId": "functionsListRuntimes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9521,7 +9889,8 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 370, + "group": "runtimes", + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -9551,9 +9920,7 @@ "get": { "summary": "List specifications", "operationId": "functionsListSpecifications", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9571,7 +9938,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 371, + "group": "runtimes", + "weight": 378, "cookies": false, "type": "", "deprecated": false, @@ -9602,9 +9970,7 @@ "get": { "summary": "List templates", "operationId": "functionsListTemplates", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9622,7 +9988,8 @@ }, "x-appwrite": { "method": "listTemplates", - "weight": 394, + "group": "templates", + "weight": 401, "cookies": false, "type": "", "deprecated": false, @@ -9697,9 +10064,7 @@ "get": { "summary": "Get function template", "operationId": "functionsGetTemplate", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9717,7 +10082,8 @@ }, "x-appwrite": { "method": "getTemplate", - "weight": 393, + "group": "templates", + "weight": 400, "cookies": false, "type": "", "deprecated": false, @@ -9756,9 +10122,7 @@ "get": { "summary": "Get functions usage", "operationId": "functionsListUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9776,7 +10140,8 @@ }, "x-appwrite": { "method": "listUsage", - "weight": 387, + "group": null, + "weight": 394, "cookies": false, "type": "", "deprecated": false, @@ -9827,9 +10192,7 @@ "get": { "summary": "Get function", "operationId": "functionsGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9847,7 +10210,8 @@ }, "x-appwrite": { "method": "get", - "weight": 366, + "group": "functions", + "weight": 373, "cookies": false, "type": "", "deprecated": false, @@ -9905,7 +10269,8 @@ }, "x-appwrite": { "method": "update", - "weight": 367, + "group": "functions", + "weight": 374, "cookies": false, "type": "", "deprecated": false, @@ -10149,7 +10514,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 369, + "group": "functions", + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -10209,7 +10575,8 @@ }, "x-appwrite": { "method": "updateFunctionDeployment", - "weight": 374, + "group": "functions", + "weight": 381, "cookies": false, "type": "", "deprecated": false, @@ -10267,9 +10634,7 @@ "get": { "summary": "List deployments", "operationId": "functionsListDeployments", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10287,7 +10652,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 375, + "group": "deployments", + "weight": 382, "cookies": false, "type": "", "deprecated": false, @@ -10366,7 +10732,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 372, + "group": "deployments", + "weight": 379, "cookies": false, "type": "upload", "deprecated": false, @@ -10457,7 +10824,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 380, + "group": "deployments", + "weight": 387, "cookies": false, "type": "", "deprecated": false, @@ -10541,7 +10909,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 377, + "group": "deployments", + "weight": 384, "cookies": false, "type": "", "deprecated": false, @@ -10646,7 +11015,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 378, + "group": "deployments", + "weight": 385, "cookies": false, "type": "", "deprecated": false, @@ -10723,9 +11093,7 @@ "get": { "summary": "Get deployment", "operationId": "functionsGetDeployment", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10743,7 +11111,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 373, + "group": "deployments", + "weight": 380, "cookies": false, "type": "", "deprecated": false, @@ -10804,7 +11173,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 376, + "group": "deployments", + "weight": 383, "cookies": false, "type": "", "deprecated": false, @@ -10850,11 +11220,9 @@ }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "functionsGetDeploymentDownload", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -10872,7 +11240,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 379, + "group": "deployments", + "weight": 386, "cookies": false, "type": "location", "deprecated": false, @@ -10957,7 +11326,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 381, + "group": "deployments", + "weight": 388, "cookies": false, "type": "", "deprecated": false, @@ -11005,9 +11375,7 @@ "get": { "summary": "List executions", "operationId": "functionsListExecutions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11025,7 +11393,8 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 384, + "group": "executions", + "weight": 391, "cookies": false, "type": "", "deprecated": false, @@ -11098,7 +11467,8 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 382, + "group": "executions", + "weight": 389, "cookies": false, "type": "", "deprecated": false, @@ -11196,9 +11566,7 @@ "get": { "summary": "Get execution", "operationId": "functionsGetExecution", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11216,7 +11584,8 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 383, + "group": "executions", + "weight": 390, "cookies": false, "type": "", "deprecated": false, @@ -11280,7 +11649,8 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 385, + "group": "executions", + "weight": 392, "cookies": false, "type": "", "deprecated": false, @@ -11328,9 +11698,7 @@ "get": { "summary": "Get function usage", "operationId": "functionsGetUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11348,7 +11716,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 386, + "group": null, + "weight": 393, "cookies": false, "type": "", "deprecated": false, @@ -11407,9 +11776,7 @@ "get": { "summary": "List variables", "operationId": "functionsListVariables", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11427,7 +11794,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 390, + "group": "variables", + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -11485,7 +11853,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 388, + "group": "variables", + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -11556,9 +11925,7 @@ "get": { "summary": "Get variable", "operationId": "functionsGetVariable", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11576,7 +11943,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 389, + "group": "variables", + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -11642,7 +12010,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 391, + "group": "variables", + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -11733,7 +12102,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 392, + "group": "variables", + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -11801,7 +12171,8 @@ }, "x-appwrite": { "method": "query", - "weight": 303, + "group": "graphql", + "weight": 305, "cookies": false, "type": "graphql", "deprecated": false, @@ -11874,7 +12245,8 @@ }, "x-appwrite": { "method": "mutation", - "weight": 302, + "group": "graphql", + "weight": 304, "cookies": false, "type": "graphql", "deprecated": false, @@ -11927,9 +12299,7 @@ "get": { "summary": "Get HTTP", "operationId": "healthGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11947,7 +12317,8 @@ }, "x-appwrite": { "method": "get", - "weight": 126, + "group": "health", + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -11977,9 +12348,7 @@ "get": { "summary": "Get antivirus", "operationId": "healthGetAntivirus", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11997,7 +12366,8 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 148, + "group": "health", + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -12027,9 +12397,7 @@ "get": { "summary": "Get cache", "operationId": "healthGetCache", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12047,7 +12415,8 @@ }, "x-appwrite": { "method": "getCache", - "weight": 129, + "group": "health", + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -12077,9 +12446,7 @@ "get": { "summary": "Get the SSL certificate for a domain", "operationId": "healthGetCertificate", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12097,7 +12464,8 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 134, + "group": "health", + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -12136,9 +12504,7 @@ "get": { "summary": "Get DB", "operationId": "healthGetDB", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12156,7 +12522,8 @@ }, "x-appwrite": { "method": "getDB", - "weight": 128, + "group": "health", + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -12186,9 +12553,7 @@ "get": { "summary": "Get pubsub", "operationId": "healthGetPubSub", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12206,7 +12571,8 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 130, + "group": "health", + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -12236,9 +12602,7 @@ "get": { "summary": "Get builds queue", "operationId": "healthGetQueueBuilds", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12256,7 +12620,8 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 136, + "group": "queue", + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -12297,9 +12662,7 @@ "get": { "summary": "Get certificates queue", "operationId": "healthGetQueueCertificates", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12317,7 +12680,8 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 135, + "group": "queue", + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -12358,9 +12722,7 @@ "get": { "summary": "Get databases queue", "operationId": "healthGetQueueDatabases", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12378,7 +12740,8 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 137, + "group": "queue", + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -12428,9 +12791,7 @@ "get": { "summary": "Get deletes queue", "operationId": "healthGetQueueDeletes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12448,7 +12809,8 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 138, + "group": "queue", + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -12489,9 +12851,7 @@ "get": { "summary": "Get number of failed queue jobs", "operationId": "healthGetFailedJobs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12509,7 +12869,8 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 149, + "group": "queue", + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -12548,7 +12909,6 @@ "v1-functions", "v1-stats-resources", "v1-stats-usage", - "v1-stats-usage-dump", "v1-webhooks", "v1-certificates", "v1-builds", @@ -12575,9 +12935,7 @@ "get": { "summary": "Get functions queue", "operationId": "healthGetQueueFunctions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12595,7 +12953,8 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 142, + "group": "queue", + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -12636,9 +12995,7 @@ "get": { "summary": "Get logs queue", "operationId": "healthGetQueueLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12656,7 +13013,8 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 133, + "group": "queue", + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -12697,9 +13055,7 @@ "get": { "summary": "Get mails queue", "operationId": "healthGetQueueMails", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12717,7 +13073,8 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 139, + "group": "queue", + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -12758,9 +13115,7 @@ "get": { "summary": "Get messaging queue", "operationId": "healthGetQueueMessaging", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12778,7 +13133,8 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 140, + "group": "queue", + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -12819,9 +13175,7 @@ "get": { "summary": "Get migrations queue", "operationId": "healthGetQueueMigrations", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12839,7 +13193,8 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 141, + "group": "queue", + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -12880,9 +13235,7 @@ "get": { "summary": "Get stats resources queue", "operationId": "healthGetQueueStatsResources", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12900,7 +13253,8 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 143, + "group": "queue", + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -12941,9 +13295,7 @@ "get": { "summary": "Get stats usage queue", "operationId": "healthGetQueueUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12961,7 +13313,8 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 144, + "group": "queue", + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -12998,74 +13351,11 @@ ] } }, - "\/health\/queue\/stats-usage-dump": { - "get": { - "summary": "Get usage dump queue", - "operationId": "healthGetQueueStatsUsageDump", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "health" - ], - "description": "Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.", - "responses": { - "200": { - "description": "Health Queue", - "schema": { - "$ref": "#\/definitions\/healthQueue" - } - } - }, - "x-appwrite": { - "method": "getQueueStatsUsageDump", - "weight": 145, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "health\/get-queue-stats-usage-dump.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-usage-dump.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "health.read", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "threshold", - "description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.", - "required": false, - "type": "integer", - "format": "int32", - "default": 5000, - "in": "query" - } - ] - } - }, "\/health\/queue\/webhooks": { "get": { "summary": "Get webhooks queue", "operationId": "healthGetQueueWebhooks", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13083,7 +13373,8 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 132, + "group": "queue", + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -13124,9 +13415,7 @@ "get": { "summary": "Get storage", "operationId": "healthGetStorage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13144,7 +13433,8 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 147, + "group": "storage", + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -13174,9 +13464,7 @@ "get": { "summary": "Get local storage", "operationId": "healthGetStorageLocal", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13194,7 +13482,8 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 146, + "group": "storage", + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -13224,9 +13513,7 @@ "get": { "summary": "Get time", "operationId": "healthGetTime", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13244,7 +13531,8 @@ }, "x-appwrite": { "method": "getTime", - "weight": 131, + "group": "health", + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -13274,9 +13562,7 @@ "get": { "summary": "Get user locale", "operationId": "localeGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13294,7 +13580,8 @@ }, "x-appwrite": { "method": "get", - "weight": 118, + "group": null, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -13327,9 +13614,7 @@ "get": { "summary": "List locale codes", "operationId": "localeListCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13347,7 +13632,8 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 119, + "group": null, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -13380,9 +13666,7 @@ "get": { "summary": "List continents", "operationId": "localeListContinents", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13400,7 +13684,8 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 123, + "group": null, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -13433,9 +13718,7 @@ "get": { "summary": "List countries", "operationId": "localeListCountries", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13453,7 +13736,8 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 120, + "group": null, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -13486,9 +13770,7 @@ "get": { "summary": "List EU countries", "operationId": "localeListCountriesEU", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13506,7 +13788,8 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 121, + "group": null, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -13539,9 +13822,7 @@ "get": { "summary": "List countries phone codes", "operationId": "localeListCountriesPhones", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13559,7 +13840,8 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 122, + "group": null, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -13592,9 +13874,7 @@ "get": { "summary": "List currencies", "operationId": "localeListCurrencies", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13612,7 +13892,8 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 124, + "group": null, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -13645,9 +13926,7 @@ "get": { "summary": "List languages", "operationId": "localeListLanguages", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13665,7 +13944,8 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 125, + "group": null, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -13698,9 +13978,7 @@ "get": { "summary": "List messages", "operationId": "messagingListMessages", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13718,7 +13996,8 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 357, + "group": "messages", + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -13792,7 +14071,8 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 354, + "group": "messages", + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -13949,7 +14229,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 361, + "group": "messages", + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -14103,7 +14384,8 @@ }, "x-appwrite": { "method": "createPush", - "weight": 356, + "group": "messages", + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -14297,7 +14579,8 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 363, + "group": "messages", + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -14490,7 +14773,8 @@ }, "x-appwrite": { "method": "createSms", - "weight": 355, + "group": "messages", + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -14607,7 +14891,8 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 362, + "group": "messages", + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -14702,9 +14987,7 @@ "get": { "summary": "Get message", "operationId": "messagingGetMessage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -14722,7 +15005,8 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 360, + "group": "messages", + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -14776,7 +15060,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 364, + "group": "messages", + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -14817,9 +15102,7 @@ "get": { "summary": "List message logs", "operationId": "messagingListMessageLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -14837,7 +15120,8 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 358, + "group": "logs", + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -14890,9 +15174,7 @@ "get": { "summary": "List message targets", "operationId": "messagingListTargets", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -14910,7 +15192,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 359, + "group": "messages", + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -14963,9 +15246,7 @@ "get": { "summary": "List providers", "operationId": "messagingListProviders", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -14983,7 +15264,8 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 329, + "group": "providers", + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -15057,7 +15339,8 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 328, + "group": "providers", + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -15171,7 +15454,8 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 341, + "group": "providers", + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -15283,7 +15567,8 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 327, + "group": "providers", + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -15373,7 +15658,8 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 340, + "group": "providers", + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -15461,7 +15747,8 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 319, + "group": "providers", + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -15587,7 +15874,8 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 332, + "group": "providers", + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -15711,7 +15999,8 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 322, + "group": "providers", + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -15813,7 +16102,8 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 335, + "group": "providers", + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -15913,7 +16203,8 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 320, + "group": "providers", + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -16027,7 +16318,8 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 333, + "group": "providers", + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -16139,7 +16431,8 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 321, + "group": "providers", + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -16297,7 +16590,8 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 334, + "group": "providers", + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -16452,7 +16746,8 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 323, + "group": "providers", + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -16554,7 +16849,8 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 336, + "group": "providers", + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -16654,7 +16950,8 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 324, + "group": "providers", + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -16756,7 +17053,8 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 337, + "group": "providers", + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -16856,7 +17154,8 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 325, + "group": "providers", + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -16958,7 +17257,8 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 338, + "group": "providers", + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -17058,7 +17358,8 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 326, + "group": "providers", + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -17160,7 +17461,8 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 339, + "group": "providers", + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -17240,9 +17542,7 @@ "get": { "summary": "Get provider", "operationId": "messagingGetProvider", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17260,7 +17560,8 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 331, + "group": "providers", + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -17314,7 +17615,8 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 342, + "group": "providers", + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -17355,9 +17657,7 @@ "get": { "summary": "List provider logs", "operationId": "messagingListProviderLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17375,7 +17675,8 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 330, + "group": "providers", + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -17428,9 +17729,7 @@ "get": { "summary": "List subscriber logs", "operationId": "messagingListSubscriberLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17448,7 +17747,8 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 351, + "group": "subscribers", + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -17501,9 +17801,7 @@ "get": { "summary": "List topics", "operationId": "messagingListTopics", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17521,7 +17819,8 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 344, + "group": "topics", + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -17593,7 +17892,8 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 343, + "group": "topics", + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -17662,9 +17962,7 @@ "get": { "summary": "Get topic", "operationId": "messagingGetTopic", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17682,7 +17980,8 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 346, + "group": "topics", + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -17741,7 +18040,8 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 347, + "group": "topics", + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -17819,7 +18119,8 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 348, + "group": "topics", + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -17860,9 +18161,7 @@ "get": { "summary": "List topic logs", "operationId": "messagingListTopicLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17880,7 +18179,8 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 345, + "group": "topics", + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -17933,9 +18233,7 @@ "get": { "summary": "List subscribers", "operationId": "messagingListSubscribers", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17953,7 +18251,8 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 350, + "group": "subscribers", + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -18033,7 +18332,8 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 349, + "group": "subscribers", + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -18102,9 +18402,7 @@ "get": { "summary": "Get subscriber", "operationId": "messagingGetSubscriber", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18122,7 +18420,8 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 352, + "group": "subscribers", + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -18184,7 +18483,8 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 353, + "group": "subscribers", + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -18236,9 +18536,7 @@ "get": { "summary": "List migrations", "operationId": "migrationsList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18256,7 +18554,8 @@ }, "x-appwrite": { "method": "list", - "weight": 311, + "group": null, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -18306,7 +18605,7 @@ }, "\/migrations\/appwrite": { "post": { - "summary": "Migrate Appwrite data", + "summary": "Create Appwrite migration", "operationId": "migrationsCreateAppwriteMigration", "consumes": [ "application\/json" @@ -18328,7 +18627,8 @@ }, "x-appwrite": { "method": "createAppwriteMigration", - "weight": 306, + "group": null, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -18399,11 +18699,9 @@ }, "\/migrations\/appwrite\/report": { "get": { - "summary": "Generate a report on Appwrite data", + "summary": "Get Appwrite migration report", "operationId": "migrationsGetAppwriteReport", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18421,7 +18719,8 @@ }, "x-appwrite": { "method": "getAppwriteReport", - "weight": 313, + "group": null, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -18508,7 +18807,8 @@ }, "x-appwrite": { "method": "createCsvMigration", - "weight": 310, + "group": null, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -18569,7 +18869,7 @@ }, "\/migrations\/firebase": { "post": { - "summary": "Migrate Firebase data", + "summary": "Create Firebase migration", "operationId": "migrationsCreateFirebaseMigration", "consumes": [ "application\/json" @@ -18591,7 +18891,8 @@ }, "x-appwrite": { "method": "createFirebaseMigration", - "weight": 307, + "group": null, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -18648,11 +18949,9 @@ }, "\/migrations\/firebase\/report": { "get": { - "summary": "Generate a report on Firebase data", + "summary": "Get Firebase migration report", "operationId": "migrationsGetFirebaseReport", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18670,7 +18969,8 @@ }, "x-appwrite": { "method": "getFirebaseReport", - "weight": 314, + "group": null, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -18718,7 +19018,7 @@ }, "\/migrations\/nhost": { "post": { - "summary": "Migrate NHost data", + "summary": "Create NHost migration", "operationId": "migrationsCreateNHostMigration", "consumes": [ "application\/json" @@ -18740,7 +19040,8 @@ }, "x-appwrite": { "method": "createNHostMigration", - "weight": 309, + "group": null, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -18838,11 +19139,9 @@ }, "\/migrations\/nhost\/report": { "get": { - "summary": "Generate a report on NHost Data", + "summary": "Get NHost migration report", "operationId": "migrationsGetNHostReport", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18860,7 +19159,8 @@ }, "x-appwrite": { "method": "getNHostReport", - "weight": 316, + "group": null, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -18957,7 +19257,7 @@ }, "\/migrations\/supabase": { "post": { - "summary": "Migrate Supabase data", + "summary": "Create Supabase migration", "operationId": "migrationsCreateSupabaseMigration", "consumes": [ "application\/json" @@ -18979,7 +19279,8 @@ }, "x-appwrite": { "method": "createSupabaseMigration", - "weight": 308, + "group": null, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -19070,11 +19371,9 @@ }, "\/migrations\/supabase\/report": { "get": { - "summary": "Generate a report on Supabase Data", + "summary": "Get Supabase migration report", "operationId": "migrationsGetSupabaseReport", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19092,7 +19391,8 @@ }, "x-appwrite": { "method": "getSupabaseReport", - "weight": 315, + "group": null, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -19184,9 +19484,7 @@ "get": { "summary": "Get migration", "operationId": "migrationsGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19204,7 +19502,8 @@ }, "x-appwrite": { "method": "get", - "weight": 312, + "group": null, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -19239,7 +19538,7 @@ ] }, "patch": { - "summary": "Retry migration", + "summary": "Update retry migration", "operationId": "migrationsRetry", "consumes": [ "application\/json" @@ -19261,7 +19560,8 @@ }, "x-appwrite": { "method": "retry", - "weight": 317, + "group": null, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -19313,7 +19613,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 318, + "group": null, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -19352,9 +19653,7 @@ "get": { "summary": "Get project usage stats", "operationId": "projectGetUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19372,7 +19671,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 197, + "group": null, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -19435,9 +19735,7 @@ "get": { "summary": "List variables", "operationId": "projectListVariables", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19455,7 +19753,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 199, + "group": null, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -19502,7 +19801,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 198, + "group": null, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -19564,9 +19864,7 @@ "get": { "summary": "Get variable", "operationId": "projectGetVariable", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19584,7 +19882,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 200, + "group": null, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -19641,7 +19940,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 201, + "group": null, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -19723,7 +20023,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 202, + "group": null, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -19762,9 +20063,7 @@ "get": { "summary": "List projects", "operationId": "projectsList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19782,7 +20081,8 @@ }, "x-appwrite": { "method": "list", - "weight": 152, + "group": "projects", + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -19852,7 +20152,8 @@ }, "x-appwrite": { "method": "create", - "weight": 151, + "group": "projects", + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -19980,9 +20281,7 @@ "get": { "summary": "Get project", "operationId": "projectsGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -20000,7 +20299,8 @@ }, "x-appwrite": { "method": "get", - "weight": 153, + "group": "projects", + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -20057,7 +20357,8 @@ }, "x-appwrite": { "method": "update", - "weight": 154, + "group": "projects", + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -20181,7 +20482,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 171, + "group": "projects", + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -20240,7 +20542,8 @@ }, "x-appwrite": { "method": "updateApiStatus", - "weight": 158, + "group": "projects", + "weight": 160, "cookies": false, "type": "", "deprecated": false, @@ -20331,7 +20634,8 @@ }, "x-appwrite": { "method": "updateApiStatusAll", - "weight": 159, + "group": "projects", + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -20369,25 +20673,510 @@ "schema": { "type": "object", "properties": { - "status": { + "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" + } + } + }, + "x-appwrite": { + "method": "updateAuthDuration", + "group": "auth", + "weight": 166, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-auth-duration.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "duration": { + "type": "integer", + "description": "Project session length in seconds. Max length: 31536000 seconds.", + "default": null, + "x-example": 0 + } + }, + "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" + } + } + }, + "x-appwrite": { + "method": "updateAuthLimit", + "group": "auth", + "weight": 165, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-auth-limit.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Set the max number of users allowed in this project. Use 0 for unlimited.", + "default": null, + "x-example": 0 + } + }, + "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" + } + } + }, + "x-appwrite": { + "method": "updateAuthSessionsLimit", + "group": "auth", + "weight": 171, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-auth-sessions-limit.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "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 + } + }, + "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" + } + } + }, + "x-appwrite": { + "method": "updateMembershipsPrivacy", + "group": "auth", + "weight": 164, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-memberships-privacy.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "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" + } + } + }, + "x-appwrite": { + "method": "updateMockNumbers", + "group": "auth", + "weight": 172, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-mock-numbers.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "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", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "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": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "x-appwrite": { + "method": "updateAuthPasswordDictionary", + "group": "auth", + "weight": 169, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "projects\/update-auth-password-dictionary.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { "type": "boolean", - "description": "API status.", + "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": [ - "status" + "enabled" ] } } ] } }, - "\/projects\/{projectId}\/auth\/duration": { + "\/projects\/{projectId}\/auth\/password-history": { "patch": { - "summary": "Update project authentication duration", - "operationId": "projectsUpdateAuthDuration", + "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" ], @@ -20397,7 +21186,7 @@ "tags": [ "projects" ], - "description": "Update how long sessions created within a project should stay active for.", + "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", @@ -20407,13 +21196,14 @@ } }, "x-appwrite": { - "method": "updateAuthDuration", - "weight": 164, + "method": "updateAuthPasswordHistory", + "group": "auth", + "weight": 168, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-auth-duration.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md", + "demo": "projects\/update-auth-password-history.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20446,25 +21236,25 @@ "schema": { "type": "object", "properties": { - "duration": { + "limit": { "type": "integer", - "description": "Project session length in seconds. Max length: 31536000 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", "default": null, "x-example": 0 } }, "required": [ - "duration" + "limit" ] } } ] } }, - "\/projects\/{projectId}\/auth\/limit": { + "\/projects\/{projectId}\/auth\/personal-data": { "patch": { - "summary": "Update project users limit", - "operationId": "projectsUpdateAuthLimit", + "summary": "Update personal data check", + "operationId": "projectsUpdatePersonalDataCheck", "consumes": [ "application\/json" ], @@ -20474,7 +21264,7 @@ "tags": [ "projects" ], - "description": "Update the maximum number of users allowed in this project. Set to 0 for unlimited users. ", + "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": "Project", @@ -20484,13 +21274,14 @@ } }, "x-appwrite": { - "method": "updateAuthLimit", - "weight": 163, + "method": "updatePersonalDataCheck", + "group": "auth", + "weight": 170, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-auth-limit.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md", + "demo": "projects\/update-personal-data-check.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20523,25 +21314,25 @@ "schema": { "type": "object", "properties": { - "limit": { - "type": "integer", - "description": "Set the max number of users allowed in this project. Use 0 for unlimited.", + "enabled": { + "type": "boolean", + "description": "Set whether or not to check a password for similarity with personal data. Default is false.", "default": null, - "x-example": 0 + "x-example": false } }, "required": [ - "limit" + "enabled" ] } } ] } }, - "\/projects\/{projectId}\/auth\/max-sessions": { + "\/projects\/{projectId}\/auth\/session-alerts": { "patch": { - "summary": "Update project user sessions limit", - "operationId": "projectsUpdateAuthSessionsLimit", + "summary": "Update project sessions emails", + "operationId": "projectsUpdateSessionAlerts", "consumes": [ "application\/json" ], @@ -20551,7 +21342,7 @@ "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.", + "description": "Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.", "responses": { "200": { "description": "Project", @@ -20561,13 +21352,14 @@ } }, "x-appwrite": { - "method": "updateAuthSessionsLimit", - "weight": 169, + "method": "updateSessionAlerts", + "group": "auth", + "weight": 163, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-auth-sessions-limit.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md", + "demo": "projects\/update-session-alerts.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20600,25 +21392,25 @@ "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", + "alerts": { + "type": "boolean", + "description": "Set to true to enable session emails.", "default": null, - "x-example": 1 + "x-example": false } }, "required": [ - "limit" + "alerts" ] } } ] } }, - "\/projects\/{projectId}\/auth\/memberships-privacy": { + "\/projects\/{projectId}\/auth\/{method}": { "patch": { - "summary": "Update project memberships privacy attributes", - "operationId": "projectsUpdateMembershipsPrivacy", + "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" ], @@ -20628,7 +21420,7 @@ "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": "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": "Project", @@ -20638,13 +21430,14 @@ } }, "x-appwrite": { - "method": "updateMembershipsPrivacy", - "weight": 162, + "method": "updateAuthStatus", + "group": "auth", + "weight": 167, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-memberships-privacy.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md", + "demo": "projects\/update-auth-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20671,75 +21464,79 @@ "x-example": "", "in": "path" }, + { + "name": "method", + "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "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": [], + "in": "path" + }, { "name": "payload", "in": "body", "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.", - "default": null, - "x-example": false - }, - "mfa": { + "status": { "type": "boolean", - "description": "Set to true to show mfa to members of a team.", + "description": "Set the status of this auth method.", "default": null, "x-example": false } }, "required": [ - "userName", - "userEmail", - "mfa" + "status" ] } } ] } }, - "\/projects\/{projectId}\/auth\/mock-numbers": { - "patch": { - "summary": "Update the mock numbers for the project", - "operationId": "projectsUpdateMockNumbers", - "consumes": [ - "application\/json" - ], + "\/projects\/{projectId}\/dev-keys": { + "get": { + "summary": "List dev keys", + "operationId": "projectsListDevKeys", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "projects" ], - "description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ", + "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" } } }, "x-appwrite": { - "method": "updateMockNumbers", - "weight": 170, + "method": "listDevKeys", + "group": "devKeys", + "weight": 370, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-mock-numbers.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", + "demo": "projects\/list-dev-keys.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "projects.read", "platforms": [ "console" ], @@ -20763,33 +21560,22 @@ "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" - ] - } + "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}\/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", + }, + "post": { + "summary": "Create dev key", + "operationId": "projectsCreateDevKey", "consumes": [ "application\/json" ], @@ -20799,23 +21585,24 @@ "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": "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" } } }, "x-appwrite": { - "method": "updateAuthPasswordDictionary", - "weight": 167, + "method": "createDevKey", + "group": "devKeys", + "weight": 367, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-auth-password-dictionary.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md", + "demo": "projects\/create-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20848,55 +21635,61 @@ "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.", + "name": { + "type": "string", + "description": "Key name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" + }, + "expire": { + "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 } }, "required": [ - "enabled" + "name", + "expire" ] } } ] } }, - "\/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" - ], + "\/projects\/{projectId}\/dev-keys\/{keyId}": { + "get": { + "summary": "Get dev key", + "operationId": "projectsGetDevKey", + "consumes": [], "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.", + "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": "Project", + "description": "DevKey", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/devKey" } } }, "x-appwrite": { - "method": "updateAuthPasswordHistory", - "weight": 166, + "method": "getDevKey", + "group": "devKeys", + "weight": 369, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-auth-password-history.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md", + "demo": "projects\/get-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "projects.read", "platforms": [ "console" ], @@ -20920,30 +21713,18 @@ "in": "path" }, { - "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 - } - }, - "required": [ - "limit" - ] - } + "name": "keyId", + "description": "Key unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - } - }, - "\/projects\/{projectId}\/auth\/personal-data": { - "patch": { - "summary": "Enable or disable checking user passwords for similarity with their personal data.", - "operationId": "projectsUpdatePersonalDataCheck", + }, + "put": { + "summary": "Update dev key", + "operationId": "projectsUpdateDevKey", "consumes": [ "application\/json" ], @@ -20953,23 +21734,24 @@ "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": "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": { "200": { - "description": "Project", + "description": "DevKey", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/devKey" } } }, "x-appwrite": { - "method": "updatePersonalDataCheck", - "weight": 168, + "method": "updateDevKey", + "group": "devKeys", + "weight": 368, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-personal-data-check.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md", + "demo": "projects\/update-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20997,80 +21779,11 @@ "in": "path" }, { - "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" - ] - } - } - ] - } - }, - "\/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" - } - } - }, - "x-appwrite": { - "method": "updateSessionAlerts", - "weight": 161, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "projects\/update-session-alerts.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", - "platforms": [ - "console" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -21079,51 +21792,52 @@ "schema": { "type": "object", "properties": { - "alerts": { - "type": "boolean", - "description": "Set to true to enable session emails.", + "name": { + "type": "string", + "description": "Key name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" + }, + "expire": { + "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 } }, "required": [ - "alerts" + "name", + "expire" ] } } ] - } - }, - "\/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", + }, + "delete": { + "summary": "Delete dev key", + "operationId": "projectsDeleteDevKey", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "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": "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": "Project", - "schema": { - "$ref": "#\/definitions\/project" - } + "204": { + "description": "No content" } }, "x-appwrite": { - "method": "updateAuthStatus", - "weight": 165, + "method": "deleteDevKey", + "group": "devKeys", + "weight": 371, "cookies": false, "type": "", "deprecated": false, - "demo": "projects\/update-auth-status.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", + "demo": "projects\/delete-dev-key.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -21151,41 +21865,12 @@ "in": "path" }, { - "name": "method", - "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "name": "keyId", + "description": "Key unique 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" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "status": { - "type": "boolean", - "description": "Set the status of this auth method.", - "default": null, - "x-example": false - } - }, - "required": [ - "status" - ] - } } ] } @@ -21214,7 +21899,8 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 183, + "group": "auth", + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -21280,9 +21966,7 @@ "get": { "summary": "List keys", "operationId": "projectsListKeys", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21300,7 +21984,8 @@ }, "x-appwrite": { "method": "listKeys", - "weight": 179, + "group": "keys", + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -21357,7 +22042,8 @@ }, "x-appwrite": { "method": "createKey", - "weight": 178, + "group": "keys", + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -21430,9 +22116,7 @@ "get": { "summary": "Get key", "operationId": "projectsGetKey", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21450,7 +22134,8 @@ }, "x-appwrite": { "method": "getKey", - "weight": 180, + "group": "keys", + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -21515,7 +22200,8 @@ }, "x-appwrite": { "method": "updateKey", - "weight": 181, + "group": "keys", + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -21609,7 +22295,8 @@ }, "x-appwrite": { "method": "deleteKey", - "weight": 182, + "group": "keys", + "weight": 184, "cookies": false, "type": "", "deprecated": false, @@ -21676,7 +22363,8 @@ }, "x-appwrite": { "method": "updateOAuth2", - "weight": 160, + "group": "auth", + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -21734,6 +22422,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -21794,9 +22483,7 @@ "get": { "summary": "List platforms", "operationId": "projectsListPlatforms", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21814,7 +22501,8 @@ }, "x-appwrite": { "method": "listPlatforms", - "weight": 185, + "group": "platforms", + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -21871,7 +22559,8 @@ }, "x-appwrite": { "method": "createPlatform", - "weight": 184, + "group": "platforms", + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -21972,9 +22661,7 @@ "get": { "summary": "Get platform", "operationId": "projectsGetPlatform", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21992,7 +22679,8 @@ }, "x-appwrite": { "method": "getPlatform", - "weight": 186, + "group": "platforms", + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -22057,7 +22745,8 @@ }, "x-appwrite": { "method": "updatePlatform", - "weight": 187, + "group": "platforms", + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -22153,7 +22842,8 @@ }, "x-appwrite": { "method": "deletePlatform", - "weight": 188, + "group": "platforms", + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -22220,7 +22910,8 @@ }, "x-appwrite": { "method": "updateServiceStatus", - "weight": 156, + "group": "projects", + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -22320,7 +23011,8 @@ }, "x-appwrite": { "method": "updateServiceStatusAll", - "weight": 157, + "group": "projects", + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -22397,7 +23089,8 @@ }, "x-appwrite": { "method": "updateSmtp", - "weight": 189, + "group": "templates", + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -22525,7 +23218,8 @@ }, "x-appwrite": { "method": "createSmtpTest", - "weight": 190, + "group": "templates", + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -22662,7 +23356,8 @@ }, "x-appwrite": { "method": "updateTeam", - "weight": 155, + "group": "projects", + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -22719,9 +23414,7 @@ "get": { "summary": "Get custom email template", "operationId": "projectsGetEmailTemplate", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -22739,7 +23432,8 @@ }, "x-appwrite": { "method": "getEmailTemplate", - "weight": 192, + "group": "templates", + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22958,7 +23652,8 @@ }, "x-appwrite": { "method": "updateEmailTemplate", - "weight": 194, + "group": "templates", + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -23198,7 +23893,7 @@ ] }, "delete": { - "summary": "Reset custom email template", + "summary": "Delete custom email template", "operationId": "projectsDeleteEmailTemplate", "consumes": [ "application\/json" @@ -23220,7 +23915,8 @@ }, "x-appwrite": { "method": "deleteEmailTemplate", - "weight": 196, + "group": "templates", + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -23421,9 +24117,7 @@ "get": { "summary": "Get custom SMS template", "operationId": "projectsGetSmsTemplate", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -23441,7 +24135,8 @@ }, "x-appwrite": { "method": "getSmsTemplate", - "weight": 191, + "group": "templates", + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -23657,7 +24352,8 @@ }, "x-appwrite": { "method": "updateSmsTemplate", - "weight": 193, + "group": "templates", + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23891,7 +24587,8 @@ }, "x-appwrite": { "method": "deleteSmsTemplate", - "weight": 195, + "group": "templates", + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -24089,9 +24786,7 @@ "get": { "summary": "List webhooks", "operationId": "projectsListWebhooks", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -24109,7 +24804,8 @@ }, "x-appwrite": { "method": "listWebhooks", - "weight": 173, + "group": "webhooks", + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -24166,7 +24862,8 @@ }, "x-appwrite": { "method": "createWebhook", - "weight": 172, + "group": "webhooks", + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -24265,9 +24962,7 @@ "get": { "summary": "Get webhook", "operationId": "projectsGetWebhook", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -24285,7 +24980,8 @@ }, "x-appwrite": { "method": "getWebhook", - "weight": 174, + "group": "webhooks", + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -24350,7 +25046,8 @@ }, "x-appwrite": { "method": "updateWebhook", - "weight": 175, + "group": "webhooks", + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -24470,7 +25167,8 @@ }, "x-appwrite": { "method": "deleteWebhook", - "weight": 177, + "group": "webhooks", + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -24537,7 +25235,8 @@ }, "x-appwrite": { "method": "updateWebhookSignature", - "weight": 176, + "group": "webhooks", + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -24584,9 +25283,7 @@ "get": { "summary": "List rules", "operationId": "proxyListRules", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -24604,7 +25301,8 @@ }, "x-appwrite": { "method": "listRules", - "weight": 289, + "group": null, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -24676,7 +25374,8 @@ }, "x-appwrite": { "method": "createAPIRule", - "weight": 425, + "group": null, + "weight": 432, "cookies": false, "type": "", "deprecated": false, @@ -24745,7 +25444,8 @@ }, "x-appwrite": { "method": "createFunctionRule", - "weight": 427, + "group": null, + "weight": 434, "cookies": false, "type": "", "deprecated": false, @@ -24827,7 +25527,8 @@ }, "x-appwrite": { "method": "createRedirectRule", - "weight": 428, + "group": null, + "weight": 435, "cookies": false, "type": "", "deprecated": false, @@ -24923,7 +25624,8 @@ }, "x-appwrite": { "method": "createSiteRule", - "weight": 426, + "group": null, + "weight": 433, "cookies": false, "type": "", "deprecated": false, @@ -24985,9 +25687,7 @@ "get": { "summary": "Get rule", "operationId": "proxyGetRule", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25005,7 +25705,8 @@ }, "x-appwrite": { "method": "getRule", - "weight": 290, + "group": null, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -25057,7 +25758,8 @@ }, "x-appwrite": { "method": "deleteRule", - "weight": 291, + "group": null, + "weight": 293, "cookies": false, "type": "", "deprecated": false, @@ -25116,7 +25818,8 @@ }, "x-appwrite": { "method": "updateRuleVerification", - "weight": 292, + "group": null, + "weight": 294, "cookies": false, "type": "", "deprecated": false, @@ -25155,9 +25858,7 @@ "get": { "summary": "List sites", "operationId": "sitesList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25175,7 +25876,8 @@ }, "x-appwrite": { "method": "list", - "weight": 397, + "group": "sites", + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -25246,7 +25948,8 @@ }, "x-appwrite": { "method": "create", - "weight": 395, + "group": "sites", + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -25306,6 +26009,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -25491,9 +26195,7 @@ "get": { "summary": "List frameworks", "operationId": "sitesListFrameworks", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25511,7 +26213,8 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 400, + "group": "frameworks", + "weight": 407, "cookies": false, "type": "", "deprecated": false, @@ -25541,9 +26244,7 @@ "get": { "summary": "List specifications", "operationId": "sitesListSpecifications", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25561,7 +26262,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 423, + "group": "frameworks", + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -25592,9 +26294,7 @@ "get": { "summary": "List templates", "operationId": "sitesListTemplates", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25612,7 +26312,8 @@ }, "x-appwrite": { "method": "listTemplates", - "weight": 419, + "group": "templates", + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -25687,9 +26388,7 @@ "get": { "summary": "Get site template", "operationId": "sitesGetTemplate", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25707,7 +26406,8 @@ }, "x-appwrite": { "method": "getTemplate", - "weight": 420, + "group": "templates", + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -25746,9 +26446,7 @@ "get": { "summary": "Get sites usage", "operationId": "sitesListUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25766,7 +26464,8 @@ }, "x-appwrite": { "method": "listUsage", - "weight": 421, + "group": null, + "weight": 428, "cookies": false, "type": "", "deprecated": false, @@ -25817,9 +26516,7 @@ "get": { "summary": "Get site", "operationId": "sitesGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -25837,7 +26534,8 @@ }, "x-appwrite": { "method": "get", - "weight": 396, + "group": "sites", + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -25895,7 +26593,8 @@ }, "x-appwrite": { "method": "update", - "weight": 398, + "group": "sites", + "weight": 405, "cookies": false, "type": "", "deprecated": false, @@ -25957,6 +26656,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -26153,7 +26853,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 399, + "group": "sites", + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -26213,7 +26914,8 @@ }, "x-appwrite": { "method": "updateSiteDeployment", - "weight": 406, + "group": "sites", + "weight": 413, "cookies": false, "type": "", "deprecated": false, @@ -26271,9 +26973,7 @@ "get": { "summary": "List deployments", "operationId": "sitesListDeployments", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -26291,7 +26991,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 405, + "group": "deployments", + "weight": 412, "cookies": false, "type": "", "deprecated": false, @@ -26370,7 +27071,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 401, + "group": "deployments", + "weight": 408, "cookies": false, "type": "upload", "deprecated": false, @@ -26469,7 +27171,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 409, + "group": "deployments", + "weight": 416, "cookies": false, "type": "", "deprecated": false, @@ -26547,7 +27250,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 402, + "group": "deployments", + "weight": 409, "cookies": false, "type": "", "deprecated": false, @@ -26652,7 +27356,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 403, + "group": "deployments", + "weight": 410, "cookies": false, "type": "", "deprecated": false, @@ -26730,9 +27435,7 @@ "get": { "summary": "Get deployment", "operationId": "sitesGetDeployment", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -26750,7 +27453,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 404, + "group": "deployments", + "weight": 411, "cookies": false, "type": "", "deprecated": false, @@ -26811,7 +27515,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 407, + "group": "deployments", + "weight": 414, "cookies": false, "type": "", "deprecated": false, @@ -26857,11 +27562,9 @@ }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "sitesGetDeploymentDownload", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -26879,7 +27582,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 408, + "group": "deployments", + "weight": 415, "cookies": false, "type": "location", "deprecated": false, @@ -26964,7 +27668,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 410, + "group": "deployments", + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -27012,9 +27717,7 @@ "get": { "summary": "List logs", "operationId": "sitesListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -27032,7 +27735,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 412, + "group": "logs", + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -27084,9 +27788,7 @@ "get": { "summary": "Get log", "operationId": "sitesGetLog", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -27104,7 +27806,8 @@ }, "x-appwrite": { "method": "getLog", - "weight": 411, + "group": "logs", + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -27167,7 +27870,8 @@ }, "x-appwrite": { "method": "deleteLog", - "weight": 413, + "group": "logs", + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -27215,9 +27919,7 @@ "get": { "summary": "Get site usage", "operationId": "sitesGetUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -27235,7 +27937,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 422, + "group": null, + "weight": 429, "cookies": false, "type": "", "deprecated": false, @@ -27294,9 +27997,7 @@ "get": { "summary": "List variables", "operationId": "sitesListVariables", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -27314,7 +28015,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 416, + "group": "variables", + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -27372,7 +28074,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 414, + "group": "variables", + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -27443,9 +28146,7 @@ "get": { "summary": "Get variable", "operationId": "sitesGetVariable", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -27463,7 +28164,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 415, + "group": "variables", + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -27529,7 +28231,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 417, + "group": "variables", + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -27620,7 +28323,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 418, + "group": "variables", + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -27668,9 +28372,7 @@ "get": { "summary": "List buckets", "operationId": "storageListBuckets", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -27688,7 +28390,8 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 204, + "group": "buckets", + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -27759,7 +28462,8 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 203, + "group": "buckets", + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -27877,9 +28581,7 @@ "get": { "summary": "Get bucket", "operationId": "storageGetBucket", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -27897,7 +28599,8 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 205, + "group": "buckets", + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -27955,7 +28658,8 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 206, + "group": "buckets", + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -28087,7 +28791,8 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 207, + "group": "buckets", + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -28127,9 +28832,7 @@ "get": { "summary": "List files", "operationId": "storageListFiles", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -28147,7 +28850,8 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 209, + "group": "files", + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -28229,7 +28933,8 @@ }, "x-appwrite": { "method": "createFile", - "weight": 208, + "group": "files", + "weight": 210, "cookies": false, "type": "upload", "deprecated": false, @@ -28300,9 +29005,7 @@ "get": { "summary": "Get file", "operationId": "storageGetFile", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -28320,7 +29023,8 @@ }, "x-appwrite": { "method": "getFile", - "weight": 210, + "group": "files", + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -28389,7 +29093,8 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 215, + "group": "files", + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -28477,7 +29182,8 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 216, + "group": "files", + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -28528,9 +29234,7 @@ "get": { "summary": "Get file for download", "operationId": "storageGetFileDownload", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -28548,7 +29252,8 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 212, + "group": "files", + "weight": 214, "cookies": false, "type": "location", "deprecated": false, @@ -28591,6 +29296,15 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -28599,9 +29313,7 @@ "get": { "summary": "Get file preview", "operationId": "storageGetFilePreview", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -28619,7 +29331,8 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 211, + "group": "files", + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -28707,12 +29420,12 @@ }, { "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" }, { @@ -28790,6 +29503,15 @@ "x-enum-keys": [], "default": "", "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -28798,9 +29520,7 @@ "get": { "summary": "Get file for view", "operationId": "storageGetFileView", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -28818,7 +29538,8 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 213, + "group": "files", + "weight": 215, "cookies": false, "type": "location", "deprecated": false, @@ -28861,6 +29582,15 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -28869,9 +29599,7 @@ "get": { "summary": "Get storage usage stats", "operationId": "storageGetUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -28889,7 +29617,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 217, + "group": null, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -28940,9 +29669,7 @@ "get": { "summary": "Get bucket usage stats", "operationId": "storageGetBucketUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -28960,7 +29687,8 @@ }, "x-appwrite": { "method": "getBucketUsage", - "weight": 218, + "group": null, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -29019,9 +29747,7 @@ "get": { "summary": "List teams", "operationId": "teamsList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -29039,7 +29765,8 @@ }, "x-appwrite": { "method": "list", - "weight": 220, + "group": "teams", + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -29113,7 +29840,8 @@ }, "x-appwrite": { "method": "create", - "weight": 219, + "group": "teams", + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -29184,9 +29912,7 @@ "get": { "summary": "Get team", "operationId": "teamsGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -29204,7 +29930,8 @@ }, "x-appwrite": { "method": "get", - "weight": 221, + "group": "teams", + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -29265,7 +29992,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 223, + "group": "teams", + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -29339,7 +30067,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 225, + "group": "teams", + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -29382,9 +30111,7 @@ "get": { "summary": "List team logs", "operationId": "teamsListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -29402,7 +30129,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 232, + "group": "logs", + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -29453,9 +30181,7 @@ "get": { "summary": "List team memberships", "operationId": "teamsListMemberships", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -29473,7 +30199,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 227, + "group": "memberships", + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -29555,7 +30282,8 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 226, + "group": "memberships", + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -29649,9 +30377,7 @@ "get": { "summary": "Get team membership", "operationId": "teamsGetMembership", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -29669,7 +30395,8 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 228, + "group": "memberships", + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -29738,7 +30465,8 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 229, + "group": "memberships", + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -29823,7 +30551,8 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 231, + "group": "memberships", + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -29894,7 +30623,8 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 230, + "group": "memberships", + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -29968,9 +30698,7 @@ "get": { "summary": "Get team preferences", "operationId": "teamsGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -29988,7 +30716,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 222, + "group": "teams", + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -30047,7 +30776,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 224, + "group": "teams", + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -30106,9 +30836,7 @@ "get": { "summary": "List tokens", "operationId": "tokensList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -30126,7 +30854,8 @@ }, "x-appwrite": { "method": "list", - "weight": 432, + "group": "files", + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -30137,8 +30866,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -30149,8 +30877,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -30196,7 +30923,7 @@ "tags": [ "tokens" ], - "description": "Create a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "description": "Create a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "responses": { "201": { "description": "ResourceToken", @@ -30207,19 +30934,19 @@ }, "x-appwrite": { "method": "createFileToken", - "weight": 429, + "group": "files", + "weight": 436, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/create-file-token.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -30230,8 +30957,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -30263,15 +30989,6 @@ "default": null, "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": [], - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -30283,9 +31000,7 @@ "get": { "summary": "Get token", "operationId": "tokensGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -30303,7 +31018,8 @@ }, "x-appwrite": { "method": "get", - "weight": 430, + "group": "tokens", + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -30314,8 +31030,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -30326,8 +31041,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -30353,7 +31067,7 @@ "tags": [ "tokens" ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { "200": { "description": "ResourceToken", @@ -30364,19 +31078,19 @@ }, "x-appwrite": { "method": "update", - "weight": 433, + "group": "tokens", + "weight": 439, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/update.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -30387,8 +31101,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -30412,15 +31125,6 @@ "default": null, "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -30445,7 +31149,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 434, + "group": "tokens", + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -30456,8 +31161,7 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, @@ -30468,8 +31172,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -30484,76 +31187,11 @@ ] } }, - "\/tokens\/{tokenId}\/jwt": { - "get": { - "summary": "Get token as JWT", - "operationId": "tokensGetJWT", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tokens" - ], - "description": "Get a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "responses": { - "200": { - "description": "JWT", - "schema": { - "$ref": "#\/definitions\/jwt" - } - } - }, - "x-appwrite": { - "method": "getJWT", - "weight": 431, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get-j-w-t.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "File token ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, "\/users": { "get": { "summary": "List users", "operationId": "usersList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -30571,7 +31209,8 @@ }, "x-appwrite": { "method": "list", - "weight": 242, + "group": "users", + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -30642,7 +31281,8 @@ }, "x-appwrite": { "method": "create", - "weight": 233, + "group": "users", + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -30736,7 +31376,8 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 236, + "group": "users", + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -30826,7 +31467,8 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 234, + "group": "users", + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -30896,9 +31538,7 @@ "get": { "summary": "List identities", "operationId": "usersListIdentities", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -30916,7 +31556,8 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 250, + "group": "identities", + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -30984,7 +31625,8 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 273, + "group": "identities", + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -31044,7 +31686,8 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 235, + "group": "users", + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -31134,7 +31777,8 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 238, + "group": "users", + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -31224,7 +31868,8 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 239, + "group": "users", + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -31349,7 +31994,8 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 240, + "group": "users", + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -31460,7 +32106,8 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 237, + "group": "users", + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -31551,9 +32198,7 @@ "get": { "summary": "Get users usage stats", "operationId": "usersGetUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -31571,7 +32216,8 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 275, + "group": null, + "weight": 277, "cookies": false, "type": "", "deprecated": false, @@ -31622,9 +32268,7 @@ "get": { "summary": "Get user", "operationId": "usersGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -31642,7 +32286,8 @@ }, "x-appwrite": { "method": "get", - "weight": 243, + "group": "users", + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -31695,7 +32340,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 271, + "group": "users", + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -31755,7 +32401,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 256, + "group": "users", + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -31833,7 +32480,8 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 274, + "group": "sessions", + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -31914,7 +32562,8 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 252, + "group": "users", + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -31975,9 +32624,7 @@ "get": { "summary": "List user logs", "operationId": "usersListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -31995,7 +32642,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 248, + "group": "logs", + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -32047,9 +32695,7 @@ "get": { "summary": "List user memberships", "operationId": "usersListMemberships", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -32067,7 +32713,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 247, + "group": "memberships", + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -32148,7 +32795,8 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 261, + "group": "users", + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -32221,7 +32869,8 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 266, + "group": "mfa", + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -32274,9 +32923,7 @@ "get": { "summary": "List factors", "operationId": "usersListMfaFactors", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -32294,7 +32941,8 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 262, + "group": "mfa", + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -32334,9 +32982,7 @@ "get": { "summary": "Get MFA recovery codes", "operationId": "usersGetMfaRecoveryCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -32354,7 +33000,8 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 263, + "group": "mfa", + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -32390,7 +33037,7 @@ ] }, "put": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "usersUpdateMfaRecoveryCodes", "consumes": [ "application\/json" @@ -32412,7 +33059,8 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 265, + "group": "mfa", + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -32470,7 +33118,8 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 264, + "group": "mfa", + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -32530,7 +33179,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 254, + "group": "users", + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -32608,7 +33258,8 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 255, + "group": "users", + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -32686,7 +33337,8 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 257, + "group": "users", + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -32744,9 +33396,7 @@ "get": { "summary": "Get user preferences", "operationId": "usersGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -32764,7 +33414,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 244, + "group": "users", + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -32822,7 +33473,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 259, + "group": "users", + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -32880,9 +33532,7 @@ "get": { "summary": "List user sessions", "operationId": "usersListSessions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -32900,7 +33550,8 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 246, + "group": "sessions", + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -32958,7 +33609,8 @@ }, "x-appwrite": { "method": "createSession", - "weight": 267, + "group": "sessions", + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -33011,7 +33663,8 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 270, + "group": "sessions", + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -33066,7 +33719,8 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 269, + "group": "sessions", + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -33134,7 +33788,8 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 251, + "group": "users", + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -33192,9 +33847,7 @@ "get": { "summary": "List user targets", "operationId": "usersListTargets", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -33212,7 +33865,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 249, + "group": "targets", + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -33283,7 +33937,8 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 241, + "group": "targets", + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -33375,9 +34030,7 @@ "get": { "summary": "Get user target", "operationId": "usersGetTarget", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -33395,7 +34048,8 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 245, + "group": "targets", + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -33462,7 +34116,8 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 260, + "group": "targets", + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -33551,7 +34206,8 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 272, + "group": "targets", + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -33620,7 +34276,8 @@ }, "x-appwrite": { "method": "createToken", - "weight": 268, + "group": "sessions", + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -33701,7 +34358,8 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 258, + "group": "users", + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -33779,7 +34437,8 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 253, + "group": "users", + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -33857,7 +34516,8 @@ }, "x-appwrite": { "method": "createRepositoryDetection", - "weight": 279, + "group": "repositories", + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -33933,9 +34593,7 @@ "get": { "summary": "List repositories", "operationId": "vcsListRepositories", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -33953,7 +34611,8 @@ }, "x-appwrite": { "method": "listRepositories", - "weight": 280, + "group": "repositories", + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -34033,7 +34692,8 @@ }, "x-appwrite": { "method": "createRepository", - "weight": 281, + "group": "repositories", + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -34097,9 +34757,7 @@ "get": { "summary": "Get repository", "operationId": "vcsGetRepository", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -34117,7 +34775,8 @@ }, "x-appwrite": { "method": "getRepository", - "weight": 282, + "group": "repositories", + "weight": 284, "cookies": false, "type": "", "deprecated": false, @@ -34164,9 +34823,7 @@ "get": { "summary": "List repository branches", "operationId": "vcsListRepositoryBranches", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -34184,7 +34841,8 @@ }, "x-appwrite": { "method": "listRepositoryBranches", - "weight": 283, + "group": "repositories", + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -34231,9 +34889,7 @@ "get": { "summary": "Get files and directories of a VCS repository", "operationId": "vcsGetRepositoryContents", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -34251,7 +34907,8 @@ }, "x-appwrite": { "method": "getRepositoryContents", - "weight": 278, + "group": "repositories", + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -34305,7 +34962,7 @@ }, "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { "patch": { - "summary": "Authorize external deployment", + "summary": "Update external deployment (authorize)", "operationId": "vcsUpdateExternalDeployments", "consumes": [ "application\/json" @@ -34324,7 +34981,8 @@ }, "x-appwrite": { "method": "updateExternalDeployments", - "weight": 288, + "group": "repositories", + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -34389,9 +35047,7 @@ "get": { "summary": "List installations", "operationId": "vcsListInstallations", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -34409,7 +35065,8 @@ }, "x-appwrite": { "method": "listInstallations", - "weight": 285, + "group": "installations", + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -34461,9 +35118,7 @@ "get": { "summary": "Get installation", "operationId": "vcsGetInstallation", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -34481,7 +35136,8 @@ }, "x-appwrite": { "method": "getInstallation", - "weight": 286, + "group": "installations", + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -34533,7 +35189,8 @@ }, "x-appwrite": { "method": "deleteInstallation", - "weight": 287, + "group": "installations", + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -34572,90 +35229,71 @@ "tags": [ { "name": "account", - "description": "The Account service allows you to authenticate and manage a user account.", - "x-globalAttributes": [] + "description": "The Account service allows you to authenticate and manage a user account." }, { "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.", - "x-globalAttributes": [] + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." }, { "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents", - "x-globalAttributes": [ - "databaseId" - ] + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" }, { "name": "locale", - "description": "The Locale service allows you to customize your app based on your users' location.", - "x-globalAttributes": [] + "description": "The Locale service allows you to customize your app based on your users' location." }, { "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health.", - "x-globalAttributes": [] + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." }, { "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "storage", - "description": "The Storage service allows you to manage your project files.", - "x-globalAttributes": [] + "description": "The Storage service allows you to manage your project files." }, { "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources", - "x-globalAttributes": [] + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" }, { "name": "users", - "description": "The Users service allows you to manage your project users.", - "x-globalAttributes": [] + "description": "The Users service allows you to manage your project users." }, { "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications.", - "x-globalAttributes": [] + "description": "The Sites Service allows you view, create and manage your web applications." }, { "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions.", - "x-globalAttributes": [] + "description": "The Functions Service allows you view, create and manage your Cloud Functions." }, { "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration.", - "x-globalAttributes": [] + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." }, { "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.", - "x-globalAttributes": [] + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." }, { "name": "console", - "description": "The Console service allows you to interact with console relevant informations.", - "x-globalAttributes": [] + "description": "The Console service allows you to interact with console relevant informations." }, { "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project.", - "x-globalAttributes": [] + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." }, { "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).", - "x-globalAttributes": [] + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." } ], "definitions": { @@ -35364,6 +36002,31 @@ "keys" ] }, + "devKeyList": { + "description": "Dev Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of devKeys documents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "devKeys": { + "type": "array", + "description": "List of devKeys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/devKey" + }, + "x-example": "" + } + }, + "required": [ + "total", + "devKeys" + ] + }, "platformList": { "description": "Platforms List", "type": "object", @@ -36751,6 +37414,15 @@ }, "x-example": [] }, + "lengths": { + "type": "array", + "description": "Index attributes length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, "orders": { "type": "array", "description": "Index orders.", @@ -36777,6 +37449,7 @@ "status", "error", "attributes", + "lengths", "$createdAt", "$updatedAt" ] @@ -37874,29 +38547,35 @@ "description": "Resource ID.", "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" }, - "resourceInternalId": { - "type": "string", - "description": "File ID.", - "x-example": "1:1" - }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "file" + "x-example": "files" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + }, + "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" } }, "required": [ "$id", "$createdAt", "resourceId", - "resourceInternalId", "resourceType", - "expire" + "expire", + "secret", + "accessedAt" ] }, "team": { @@ -39715,6 +40394,15 @@ }, "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", @@ -39898,6 +40586,7 @@ "platforms", "webhooks", "keys", + "devKeys", "smtpEnabled", "smtpSenderName", "smtpSenderEmail", @@ -40088,6 +40777,65 @@ "sdks" ] }, + "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" + ] + }, "mockNumber": { "description": "Mock Number", "type": "object", diff --git a/app/config/specs/swagger2-1.7.x-server.json b/app/config/specs/swagger2-1.7.x-server.json index 28c56410fb0..5e535655dd3 100644 --- a/app/config/specs/swagger2-1.7.x-server.json +++ b/app/config/specs/swagger2-1.7.x-server.json @@ -16,6 +16,7 @@ } }, "host": "cloud.appwrite.io", + "x-host-docs": ".cloud.appwrite.io", "basePath": "\/v1", "schemes": [ "https" @@ -82,9 +83,7 @@ "get": { "summary": "Get account", "operationId": "accountGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -102,6 +101,7 @@ }, "x-appwrite": { "method": "get", + "group": "account", "weight": 10, "cookies": false, "type": "", @@ -153,6 +153,7 @@ }, "x-appwrite": { "method": "create", + "group": "account", "weight": 9, "cookies": false, "type": "", @@ -243,6 +244,7 @@ }, "x-appwrite": { "method": "updateEmail", + "group": "account", "weight": 35, "cookies": false, "type": "", @@ -303,9 +305,7 @@ "get": { "summary": "List identities", "operationId": "accountListIdentities", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -323,6 +323,7 @@ }, "x-appwrite": { "method": "listIdentities", + "group": "identities", "weight": 58, "cookies": false, "type": "", @@ -385,6 +386,7 @@ }, "x-appwrite": { "method": "deleteIdentity", + "group": "identities", "weight": 59, "cookies": false, "type": "", @@ -448,6 +450,7 @@ }, "x-appwrite": { "method": "createJWT", + "group": "tokens", "weight": 30, "cookies": false, "type": "", @@ -478,9 +481,7 @@ "get": { "summary": "List logs", "operationId": "accountListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -498,6 +499,7 @@ }, "x-appwrite": { "method": "listLogs", + "group": "logs", "weight": 32, "cookies": false, "type": "", @@ -565,6 +567,7 @@ }, "x-appwrite": { "method": "updateMFA", + "group": "mfa", "weight": 45, "cookies": false, "type": "", @@ -638,6 +641,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", + "group": "mfa", "weight": 47, "cookies": false, "type": "", @@ -682,7 +686,7 @@ ] }, "put": { - "summary": "Verify authenticator", + "summary": "Update authenticator (confirmation)", "operationId": "accountUpdateMfaAuthenticator", "consumes": [ "application\/json" @@ -704,6 +708,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", + "group": "mfa", "weight": 48, "cookies": false, "type": "", @@ -783,6 +788,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", + "group": "mfa", "weight": 52, "cookies": false, "type": "", @@ -851,6 +857,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", + "group": "mfa", "weight": 53, "cookies": false, "type": "", @@ -905,7 +912,7 @@ ] }, "put": { - "summary": "Create MFA challenge (confirmation)", + "summary": "Update MFA challenge (confirmation)", "operationId": "accountUpdateMfaChallenge", "consumes": [ "application\/json" @@ -927,6 +934,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", + "group": "mfa", "weight": 54, "cookies": false, "type": "", @@ -987,9 +995,7 @@ "get": { "summary": "List factors", "operationId": "accountListMfaFactors", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1007,6 +1013,7 @@ }, "x-appwrite": { "method": "listMfaFactors", + "group": "mfa", "weight": 46, "cookies": false, "type": "", @@ -1038,11 +1045,9 @@ }, "\/account\/mfa\/recovery-codes": { "get": { - "summary": "Get MFA recovery codes", + "summary": "List MFA recovery codes", "operationId": "accountGetMfaRecoveryCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1060,6 +1065,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", + "group": "mfa", "weight": 51, "cookies": false, "type": "", @@ -1111,6 +1117,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", + "group": "mfa", "weight": 49, "cookies": false, "type": "", @@ -1140,7 +1147,7 @@ ] }, "patch": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "accountUpdateMfaRecoveryCodes", "consumes": [ "application\/json" @@ -1162,6 +1169,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", + "group": "mfa", "weight": 50, "cookies": false, "type": "", @@ -1215,6 +1223,7 @@ }, "x-appwrite": { "method": "updateName", + "group": "account", "weight": 33, "cookies": false, "type": "", @@ -1288,6 +1297,7 @@ }, "x-appwrite": { "method": "updatePassword", + "group": "account", "weight": 34, "cookies": false, "type": "", @@ -1367,6 +1377,7 @@ }, "x-appwrite": { "method": "updatePhone", + "group": "account", "weight": 36, "cookies": false, "type": "", @@ -1427,9 +1438,7 @@ "get": { "summary": "Get account preferences", "operationId": "accountGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1447,6 +1456,7 @@ }, "x-appwrite": { "method": "getPrefs", + "group": "account", "weight": 31, "cookies": false, "type": "", @@ -1498,6 +1508,7 @@ }, "x-appwrite": { "method": "updatePrefs", + "group": "account", "weight": 37, "cookies": false, "type": "", @@ -1571,6 +1582,7 @@ }, "x-appwrite": { "method": "createRecovery", + "group": "recovery", "weight": 39, "cookies": false, "type": "", @@ -1630,7 +1642,7 @@ ] }, "put": { - "summary": "Create password recovery (confirmation)", + "summary": "Update password recovery (confirmation)", "operationId": "accountUpdateRecovery", "consumes": [ "application\/json" @@ -1652,6 +1664,7 @@ }, "x-appwrite": { "method": "updateRecovery", + "group": "recovery", "weight": 40, "cookies": false, "type": "", @@ -1719,9 +1732,7 @@ "get": { "summary": "List sessions", "operationId": "accountListSessions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -1739,6 +1750,7 @@ }, "x-appwrite": { "method": "listSessions", + "group": "sessions", "weight": 12, "cookies": false, "type": "", @@ -1785,6 +1797,7 @@ }, "x-appwrite": { "method": "deleteSessions", + "group": "sessions", "weight": 13, "cookies": false, "type": "", @@ -1838,6 +1851,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", + "group": "sessions", "weight": 18, "cookies": false, "type": "", @@ -1888,6 +1902,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", + "group": "sessions", "weight": 17, "cookies": false, "type": "", @@ -1965,6 +1980,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", + "group": "sessions", "weight": 27, "cookies": false, "type": "", @@ -2042,6 +2058,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", + "group": "sessions", "weight": 28, "cookies": false, "type": "", @@ -2119,6 +2136,7 @@ }, "x-appwrite": { "method": "createSession", + "group": "sessions", "weight": 19, "cookies": false, "type": "", @@ -2176,9 +2194,7 @@ "get": { "summary": "Get session", "operationId": "accountGetSession", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -2196,6 +2212,7 @@ }, "x-appwrite": { "method": "getSession", + "group": "sessions", "weight": 14, "cookies": false, "type": "", @@ -2257,6 +2274,7 @@ }, "x-appwrite": { "method": "updateSession", + "group": "sessions", "weight": 16, "cookies": false, "type": "", @@ -2313,6 +2331,7 @@ }, "x-appwrite": { "method": "deleteSession", + "group": "sessions", "weight": 15, "cookies": false, "type": "", @@ -2376,6 +2395,7 @@ }, "x-appwrite": { "method": "updateStatus", + "group": "account", "weight": 38, "cookies": false, "type": "", @@ -2429,6 +2449,7 @@ }, "x-appwrite": { "method": "createEmailToken", + "group": "tokens", "weight": 26, "cookies": false, "type": "", @@ -2437,7 +2458,10 @@ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md", "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},email:{param-email}", + "rate-key": [ + "url:{url},email:{param-email}", + "url:{url},ip:{ip}" + ], "scope": "sessions.write", "platforms": [ "server", @@ -2512,6 +2536,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", + "group": "tokens", "weight": 25, "cookies": false, "type": "", @@ -2584,9 +2609,7 @@ "get": { "summary": "Create OAuth2 token", "operationId": "accountCreateOAuth2Token", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "text\/html" ], @@ -2601,6 +2624,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", + "group": "tokens", "weight": 24, "cookies": false, "type": "webAuth", @@ -2628,7 +2652,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, 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, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -2647,6 +2671,7 @@ "dropbox", "etsy", "facebook", + "figma", "github", "gitlab", "google", @@ -2736,6 +2761,7 @@ }, "x-appwrite": { "method": "createPhoneToken", + "group": "tokens", "weight": 29, "cookies": false, "type": "", @@ -2816,6 +2842,7 @@ }, "x-appwrite": { "method": "createVerification", + "group": "verification", "weight": 41, "cookies": false, "type": "", @@ -2865,7 +2892,7 @@ ] }, "put": { - "summary": "Create email verification (confirmation)", + "summary": "Update email verification (confirmation)", "operationId": "accountUpdateVerification", "consumes": [ "application\/json" @@ -2887,6 +2914,7 @@ }, "x-appwrite": { "method": "updateVerification", + "group": "verification", "weight": 42, "cookies": false, "type": "", @@ -2967,6 +2995,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", + "group": "verification", "weight": 43, "cookies": false, "type": "", @@ -3021,6 +3050,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", + "group": "verification", "weight": 44, "cookies": false, "type": "", @@ -3081,9 +3111,7 @@ "get": { "summary": "Get browser icon", "operationId": "avatarsGetBrowser", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3101,6 +3129,7 @@ }, "x-appwrite": { "method": "getBrowser", + "group": null, "weight": 61, "cookies": false, "type": "location", @@ -3194,12 +3223,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -3209,9 +3238,7 @@ "get": { "summary": "Get credit card icon", "operationId": "avatarsGetCreditCard", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3229,6 +3256,7 @@ }, "x-appwrite": { "method": "getCreditCard", + "group": null, "weight": 60, "cookies": false, "type": "location", @@ -3328,12 +3356,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -3343,9 +3371,7 @@ "get": { "summary": "Get favicon", "operationId": "avatarsGetFavicon", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -3363,6 +3389,7 @@ }, "x-appwrite": { "method": "getFavicon", + "group": null, "weight": 64, "cookies": false, "type": "location", @@ -3409,9 +3436,7 @@ "get": { "summary": "Get country flag", "operationId": "avatarsGetFlag", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -3429,6 +3454,7 @@ }, "x-appwrite": { "method": "getFlag", + "group": null, "weight": 62, "cookies": false, "type": "location", @@ -3884,12 +3910,12 @@ }, { "name": "quality", - "description": "Image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" } ] @@ -3899,9 +3925,7 @@ "get": { "summary": "Get image from URL", "operationId": "avatarsGetImage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -3919,6 +3943,7 @@ }, "x-appwrite": { "method": "getImage", + "group": null, "weight": 63, "cookies": false, "type": "location", @@ -3985,9 +4010,7 @@ "get": { "summary": "Get user initials", "operationId": "avatarsGetInitials", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -4005,6 +4028,7 @@ }, "x-appwrite": { "method": "getInitials", + "group": null, "weight": 66, "cookies": false, "type": "location", @@ -4079,9 +4103,7 @@ "get": { "summary": "Get QR code", "operationId": "avatarsGetQR", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/png" ], @@ -4099,6 +4121,7 @@ }, "x-appwrite": { "method": "getQR", + "group": null, "weight": 65, "cookies": false, "type": "location", @@ -4173,9 +4196,7 @@ "get": { "summary": "List databases", "operationId": "databasesList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4193,6 +4214,7 @@ }, "x-appwrite": { "method": "list", + "group": "databases", "weight": 71, "cookies": false, "type": "", @@ -4265,6 +4287,7 @@ }, "x-appwrite": { "method": "create", + "group": "databases", "weight": 70, "cookies": false, "type": "", @@ -4329,9 +4352,7 @@ "get": { "summary": "Get database", "operationId": "databasesGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4349,6 +4370,7 @@ }, "x-appwrite": { "method": "get", + "group": "databases", "weight": 72, "cookies": false, "type": "", @@ -4408,6 +4430,7 @@ }, "x-appwrite": { "method": "update", + "group": "databases", "weight": 74, "cookies": false, "type": "", @@ -4486,6 +4509,7 @@ }, "x-appwrite": { "method": "delete", + "group": "databases", "weight": 75, "cookies": false, "type": "", @@ -4527,9 +4551,7 @@ "get": { "summary": "List collections", "operationId": "databasesListCollections", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4547,6 +4569,7 @@ }, "x-appwrite": { "method": "listCollections", + "group": "collections", "weight": 77, "cookies": false, "type": "", @@ -4627,6 +4650,7 @@ }, "x-appwrite": { "method": "createCollection", + "group": "collections", "weight": 76, "cookies": false, "type": "", @@ -4714,9 +4738,7 @@ "get": { "summary": "Get collection", "operationId": "databasesGetCollection", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4734,6 +4756,7 @@ }, "x-appwrite": { "method": "getCollection", + "group": "collections", "weight": 78, "cookies": false, "type": "", @@ -4801,6 +4824,7 @@ }, "x-appwrite": { "method": "updateCollection", + "group": "collections", "weight": 80, "cookies": false, "type": "", @@ -4902,6 +4926,7 @@ }, "x-appwrite": { "method": "deleteCollection", + "group": "collections", "weight": 81, "cookies": false, "type": "", @@ -4951,9 +4976,7 @@ "get": { "summary": "List attributes", "operationId": "databasesListAttributes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -4971,6 +4994,7 @@ }, "x-appwrite": { "method": "listAttributes", + "group": "attributes", "weight": 92, "cookies": false, "type": "", @@ -5052,6 +5076,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", + "group": "attributes", "weight": 89, "cookies": false, "type": "", @@ -5158,6 +5183,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", + "group": "attributes", "weight": 101, "cookies": false, "type": "", @@ -5266,6 +5292,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", + "group": "attributes", "weight": 90, "cookies": false, "type": "", @@ -5372,6 +5399,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", + "group": "attributes", "weight": 102, "cookies": false, "type": "", @@ -5480,6 +5508,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", + "group": "attributes", "weight": 83, "cookies": false, "type": "", @@ -5586,6 +5615,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", + "group": "attributes", "weight": 95, "cookies": false, "type": "", @@ -5694,6 +5724,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", + "group": "attributes", "weight": 84, "cookies": false, "type": "", @@ -5810,6 +5841,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", + "group": "attributes", "weight": 96, "cookies": false, "type": "", @@ -5928,6 +5960,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", + "group": "attributes", "weight": 88, "cookies": false, "type": "", @@ -6046,6 +6079,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", + "group": "attributes", "weight": 100, "cookies": false, "type": "", @@ -6166,6 +6200,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", + "group": "attributes", "weight": 87, "cookies": false, "type": "", @@ -6284,6 +6319,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", + "group": "attributes", "weight": 99, "cookies": false, "type": "", @@ -6404,6 +6440,7 @@ }, "x-appwrite": { "method": "createIpAttribute", + "group": "attributes", "weight": 85, "cookies": false, "type": "", @@ -6510,6 +6547,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", + "group": "attributes", "weight": 97, "cookies": false, "type": "", @@ -6618,6 +6656,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", + "group": "attributes", "weight": 91, "cookies": false, "type": "", @@ -6751,6 +6790,7 @@ }, "x-appwrite": { "method": "createStringAttribute", + "group": "attributes", "weight": 82, "cookies": false, "type": "", @@ -6870,6 +6910,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", + "group": "attributes", "weight": 94, "cookies": false, "type": "", @@ -6984,6 +7025,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", + "group": "attributes", "weight": 86, "cookies": false, "type": "", @@ -7090,6 +7132,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", + "group": "attributes", "weight": 98, "cookies": false, "type": "", @@ -7178,9 +7221,7 @@ "get": { "summary": "Get attribute", "operationId": "databasesGetAttribute", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -7229,6 +7270,7 @@ }, "x-appwrite": { "method": "getAttribute", + "group": "attributes", "weight": 93, "cookies": false, "type": "", @@ -7298,6 +7340,7 @@ }, "x-appwrite": { "method": "deleteAttribute", + "group": "attributes", "weight": 104, "cookies": false, "type": "", @@ -7374,6 +7417,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", + "group": "attributes", "weight": 103, "cookies": false, "type": "", @@ -7458,9 +7502,7 @@ "get": { "summary": "List documents", "operationId": "databasesListDocuments", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -7478,6 +7520,7 @@ }, "x-appwrite": { "method": "listDocuments", + "group": "documents", "weight": 110, "cookies": false, "type": "", @@ -7550,7 +7593,7 @@ "tags": [ "databases" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.", "responses": { "201": { "description": "Document", @@ -7561,6 +7604,7 @@ }, "x-appwrite": { "method": "createDocument", + "group": "documents", "weight": 109, "cookies": false, "type": "", @@ -7577,6 +7621,59 @@ "server" ], "packaging": false, + "methods": [ + { + "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + } + ], "auth": { "Project": [], "Session": [] @@ -7616,13 +7713,13 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, + "default": "", "x-example": "" }, "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -7633,21 +7730,24 @@ "items": { "type": "string" } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } - }, - "required": [ - "documentId", - "data" - ] + } } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + }, + "put": { + "summary": "Create or update documents", + "operationId": "databasesUpsertDocuments", "consumes": [ "application\/json" ], @@ -7657,44 +7757,41 @@ "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n", "responses": { "200": { - "description": "Document", + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/documentList" } } }, "x-appwrite": { - "method": "getDocument", - "weight": 111, + "method": "upsertDocuments", + "group": "documents", + "weight": 115, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/get-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -7708,37 +7805,35 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + } + } } ] }, "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", "consumes": [ "application\/json" ], @@ -7748,44 +7843,41 @@ "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", "responses": { "200": { - "description": "Document", + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/documentList" } } }, "x-appwrite": { - "method": "updateDocument", - "weight": 113, + "method": "updateDocuments", + "group": "documents", + "weight": 114, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/update-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "demo": "databases\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -7805,14 +7897,6 @@ "x-example": "", "in": "path" }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", @@ -7825,11 +7909,11 @@ "default": [], "x-example": "{}" }, - "permissions": { + "queries": { "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, "items": { "type": "string" } @@ -7840,50 +7924,52 @@ ] }, "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "databases" ], - "description": "Delete a document by its unique ID.", + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } } }, "x-appwrite": { - "method": "deleteDocument", - "weight": 114, + "method": "deleteDocuments", + "group": "documents", + "weight": 117, "cookies": false, "type": "", "deprecated": false, - "demo": "databases\/delete-document.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "demo": "databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "client", - "server", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -7904,20 +7990,120 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + } + } + } + } + ] + } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { "get": { - "summary": "List indexes", - "operationId": "databasesListIndexes", + "summary": "Get document", + "operationId": "databasesGetDocument", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 111, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + }, + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", "consumes": [ "application\/json" ], @@ -7927,6 +8113,185 @@ "tags": [ "databases" ], + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 113, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete document", + "operationId": "databasesDeleteDocument", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "databases" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 116, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "databases\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "databasesListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], "description": "List indexes in the collection.", "responses": { "200": { @@ -7938,6 +8303,7 @@ }, "x-appwrite": { "method": "listIndexes", + "group": "indexes", "weight": 106, "cookies": false, "type": "", @@ -8017,6 +8383,7 @@ }, "x-appwrite": { "method": "createIndex", + "group": "collections", "weight": 105, "cookies": false, "type": "", @@ -8101,6 +8468,15 @@ "items": { "type": "string" } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } } }, "required": [ @@ -8117,9 +8493,7 @@ "get": { "summary": "Get index", "operationId": "databasesGetIndex", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8137,6 +8511,7 @@ }, "x-appwrite": { "method": "getIndex", + "group": "indexes", "weight": 107, "cookies": false, "type": "", @@ -8206,6 +8581,7 @@ }, "x-appwrite": { "method": "deleteIndex", + "group": "indexes", "weight": 108, "cookies": false, "type": "", @@ -8262,9 +8638,7 @@ "get": { "summary": "List functions", "operationId": "functionsList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8282,7 +8656,8 @@ }, "x-appwrite": { "method": "list", - "weight": 368, + "group": "functions", + "weight": 375, "cookies": false, "type": "", "deprecated": false, @@ -8354,7 +8729,8 @@ }, "x-appwrite": { "method": "create", - "weight": 365, + "group": "functions", + "weight": 372, "cookies": false, "type": "", "deprecated": false, @@ -8585,9 +8961,7 @@ "get": { "summary": "List runtimes", "operationId": "functionsListRuntimes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8605,7 +8979,8 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 370, + "group": "runtimes", + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -8636,9 +9011,7 @@ "get": { "summary": "List specifications", "operationId": "functionsListSpecifications", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8656,7 +9029,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 371, + "group": "runtimes", + "weight": 378, "cookies": false, "type": "", "deprecated": false, @@ -8688,9 +9062,7 @@ "get": { "summary": "Get function", "operationId": "functionsGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -8708,7 +9080,8 @@ }, "x-appwrite": { "method": "get", - "weight": 366, + "group": "functions", + "weight": 373, "cookies": false, "type": "", "deprecated": false, @@ -8767,7 +9140,8 @@ }, "x-appwrite": { "method": "update", - "weight": 367, + "group": "functions", + "weight": 374, "cookies": false, "type": "", "deprecated": false, @@ -9012,7 +9386,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 369, + "group": "functions", + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -9073,7 +9448,8 @@ }, "x-appwrite": { "method": "updateFunctionDeployment", - "weight": 374, + "group": "functions", + "weight": 381, "cookies": false, "type": "", "deprecated": false, @@ -9132,9 +9508,7 @@ "get": { "summary": "List deployments", "operationId": "functionsListDeployments", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9152,7 +9526,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 375, + "group": "deployments", + "weight": 382, "cookies": false, "type": "", "deprecated": false, @@ -9232,7 +9607,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 372, + "group": "deployments", + "weight": 379, "cookies": false, "type": "upload", "deprecated": false, @@ -9324,7 +9700,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 380, + "group": "deployments", + "weight": 387, "cookies": false, "type": "", "deprecated": false, @@ -9409,7 +9786,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 377, + "group": "deployments", + "weight": 384, "cookies": false, "type": "", "deprecated": false, @@ -9515,7 +9893,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 378, + "group": "deployments", + "weight": 385, "cookies": false, "type": "", "deprecated": false, @@ -9593,9 +9972,7 @@ "get": { "summary": "Get deployment", "operationId": "functionsGetDeployment", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9613,7 +9990,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 373, + "group": "deployments", + "weight": 380, "cookies": false, "type": "", "deprecated": false, @@ -9675,7 +10053,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 376, + "group": "deployments", + "weight": 383, "cookies": false, "type": "", "deprecated": false, @@ -9722,11 +10101,9 @@ }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "functionsGetDeploymentDownload", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -9744,7 +10121,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 379, + "group": "deployments", + "weight": 386, "cookies": false, "type": "location", "deprecated": false, @@ -9830,7 +10208,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 381, + "group": "deployments", + "weight": 388, "cookies": false, "type": "", "deprecated": false, @@ -9879,9 +10258,7 @@ "get": { "summary": "List executions", "operationId": "functionsListExecutions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -9899,7 +10276,8 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 384, + "group": "executions", + "weight": 391, "cookies": false, "type": "", "deprecated": false, @@ -9974,7 +10352,8 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 382, + "group": "executions", + "weight": 389, "cookies": false, "type": "", "deprecated": false, @@ -10074,9 +10453,7 @@ "get": { "summary": "Get execution", "operationId": "functionsGetExecution", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10094,7 +10471,8 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 383, + "group": "executions", + "weight": 390, "cookies": false, "type": "", "deprecated": false, @@ -10160,7 +10538,8 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 385, + "group": "executions", + "weight": 392, "cookies": false, "type": "", "deprecated": false, @@ -10209,9 +10588,7 @@ "get": { "summary": "List variables", "operationId": "functionsListVariables", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10229,7 +10606,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 390, + "group": "variables", + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -10288,7 +10666,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 388, + "group": "variables", + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -10360,9 +10739,7 @@ "get": { "summary": "Get variable", "operationId": "functionsGetVariable", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10380,7 +10757,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 389, + "group": "variables", + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -10447,7 +10825,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 391, + "group": "variables", + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -10539,7 +10918,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 392, + "group": "variables", + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -10608,7 +10988,8 @@ }, "x-appwrite": { "method": "query", - "weight": 303, + "group": "graphql", + "weight": 305, "cookies": false, "type": "graphql", "deprecated": false, @@ -10683,7 +11064,8 @@ }, "x-appwrite": { "method": "mutation", - "weight": 302, + "group": "graphql", + "weight": 304, "cookies": false, "type": "graphql", "deprecated": false, @@ -10738,9 +11120,7 @@ "get": { "summary": "Get HTTP", "operationId": "healthGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10758,7 +11138,8 @@ }, "x-appwrite": { "method": "get", - "weight": 126, + "group": "health", + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -10789,9 +11170,7 @@ "get": { "summary": "Get antivirus", "operationId": "healthGetAntivirus", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10809,7 +11188,8 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 148, + "group": "health", + "weight": 150, "cookies": false, "type": "", "deprecated": false, @@ -10840,9 +11220,7 @@ "get": { "summary": "Get cache", "operationId": "healthGetCache", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10860,7 +11238,8 @@ }, "x-appwrite": { "method": "getCache", - "weight": 129, + "group": "health", + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -10891,9 +11270,7 @@ "get": { "summary": "Get the SSL certificate for a domain", "operationId": "healthGetCertificate", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10911,7 +11288,8 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 134, + "group": "health", + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -10951,9 +11329,7 @@ "get": { "summary": "Get DB", "operationId": "healthGetDB", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -10971,7 +11347,8 @@ }, "x-appwrite": { "method": "getDB", - "weight": 128, + "group": "health", + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -11002,9 +11379,7 @@ "get": { "summary": "Get pubsub", "operationId": "healthGetPubSub", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11022,7 +11397,8 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 130, + "group": "health", + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -11053,9 +11429,7 @@ "get": { "summary": "Get builds queue", "operationId": "healthGetQueueBuilds", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11073,7 +11447,8 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 136, + "group": "queue", + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -11115,9 +11490,7 @@ "get": { "summary": "Get certificates queue", "operationId": "healthGetQueueCertificates", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11135,7 +11508,8 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 135, + "group": "queue", + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -11177,9 +11551,7 @@ "get": { "summary": "Get databases queue", "operationId": "healthGetQueueDatabases", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11197,7 +11569,8 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 137, + "group": "queue", + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -11248,9 +11621,7 @@ "get": { "summary": "Get deletes queue", "operationId": "healthGetQueueDeletes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11268,7 +11639,8 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 138, + "group": "queue", + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -11310,9 +11682,7 @@ "get": { "summary": "Get number of failed queue jobs", "operationId": "healthGetFailedJobs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11330,7 +11700,8 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 149, + "group": "queue", + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -11370,7 +11741,6 @@ "v1-functions", "v1-stats-resources", "v1-stats-usage", - "v1-stats-usage-dump", "v1-webhooks", "v1-certificates", "v1-builds", @@ -11397,9 +11767,7 @@ "get": { "summary": "Get functions queue", "operationId": "healthGetQueueFunctions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11417,7 +11785,8 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 142, + "group": "queue", + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -11459,9 +11828,7 @@ "get": { "summary": "Get logs queue", "operationId": "healthGetQueueLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11479,7 +11846,8 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 133, + "group": "queue", + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -11521,9 +11889,7 @@ "get": { "summary": "Get mails queue", "operationId": "healthGetQueueMails", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11541,7 +11907,8 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 139, + "group": "queue", + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -11583,9 +11950,7 @@ "get": { "summary": "Get messaging queue", "operationId": "healthGetQueueMessaging", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11603,7 +11968,8 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 140, + "group": "queue", + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -11645,9 +12011,7 @@ "get": { "summary": "Get migrations queue", "operationId": "healthGetQueueMigrations", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11665,7 +12029,8 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 141, + "group": "queue", + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -11707,9 +12072,7 @@ "get": { "summary": "Get stats resources queue", "operationId": "healthGetQueueStatsResources", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11727,7 +12090,8 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 143, + "group": "queue", + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -11769,9 +12133,7 @@ "get": { "summary": "Get stats usage queue", "operationId": "healthGetQueueUsage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11789,7 +12151,8 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 144, + "group": "queue", + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -11827,75 +12190,11 @@ ] } }, - "\/health\/queue\/stats-usage-dump": { - "get": { - "summary": "Get usage dump queue", - "operationId": "healthGetQueueStatsUsageDump", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "health" - ], - "description": "Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.", - "responses": { - "200": { - "description": "Health Queue", - "schema": { - "$ref": "#\/definitions\/healthQueue" - } - } - }, - "x-appwrite": { - "method": "getQueueStatsUsageDump", - "weight": 145, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "health\/get-queue-stats-usage-dump.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-usage-dump.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "health.read", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "threshold", - "description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.", - "required": false, - "type": "integer", - "format": "int32", - "default": 5000, - "in": "query" - } - ] - } - }, "\/health\/queue\/webhooks": { "get": { "summary": "Get webhooks queue", "operationId": "healthGetQueueWebhooks", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11913,7 +12212,8 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 132, + "group": "queue", + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -11955,9 +12255,7 @@ "get": { "summary": "Get storage", "operationId": "healthGetStorage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -11975,7 +12273,8 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 147, + "group": "storage", + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -12006,9 +12305,7 @@ "get": { "summary": "Get local storage", "operationId": "healthGetStorageLocal", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12026,7 +12323,8 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 146, + "group": "storage", + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -12057,9 +12355,7 @@ "get": { "summary": "Get time", "operationId": "healthGetTime", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12077,7 +12373,8 @@ }, "x-appwrite": { "method": "getTime", - "weight": 131, + "group": "health", + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -12108,9 +12405,7 @@ "get": { "summary": "Get user locale", "operationId": "localeGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12128,7 +12423,8 @@ }, "x-appwrite": { "method": "get", - "weight": 118, + "group": null, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -12163,9 +12459,7 @@ "get": { "summary": "List locale codes", "operationId": "localeListCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12183,7 +12477,8 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 119, + "group": null, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -12218,9 +12513,7 @@ "get": { "summary": "List continents", "operationId": "localeListContinents", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12238,7 +12531,8 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 123, + "group": null, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -12273,9 +12567,7 @@ "get": { "summary": "List countries", "operationId": "localeListCountries", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12293,7 +12585,8 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 120, + "group": null, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -12328,9 +12621,7 @@ "get": { "summary": "List EU countries", "operationId": "localeListCountriesEU", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12348,7 +12639,8 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 121, + "group": null, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -12383,9 +12675,7 @@ "get": { "summary": "List countries phone codes", "operationId": "localeListCountriesPhones", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12403,7 +12693,8 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 122, + "group": null, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -12438,9 +12729,7 @@ "get": { "summary": "List currencies", "operationId": "localeListCurrencies", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12458,7 +12747,8 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 124, + "group": null, + "weight": 127, "cookies": false, "type": "", "deprecated": false, @@ -12493,9 +12783,7 @@ "get": { "summary": "List languages", "operationId": "localeListLanguages", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12513,7 +12801,8 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 125, + "group": null, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -12548,9 +12837,7 @@ "get": { "summary": "List messages", "operationId": "messagingListMessages", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -12568,7 +12855,8 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 357, + "group": "messages", + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -12643,7 +12931,8 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 354, + "group": "messages", + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -12801,7 +13090,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 361, + "group": "messages", + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -12956,7 +13246,8 @@ }, "x-appwrite": { "method": "createPush", - "weight": 356, + "group": "messages", + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -13151,7 +13442,8 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 363, + "group": "messages", + "weight": 365, "cookies": false, "type": "", "deprecated": false, @@ -13345,7 +13637,8 @@ }, "x-appwrite": { "method": "createSms", - "weight": 355, + "group": "messages", + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -13463,7 +13756,8 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 362, + "group": "messages", + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -13559,9 +13853,7 @@ "get": { "summary": "Get message", "operationId": "messagingGetMessage", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13579,7 +13871,8 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 360, + "group": "messages", + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -13634,7 +13927,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 364, + "group": "messages", + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -13676,9 +13970,7 @@ "get": { "summary": "List message logs", "operationId": "messagingListMessageLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13696,7 +13988,8 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 358, + "group": "logs", + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -13750,9 +14043,7 @@ "get": { "summary": "List message targets", "operationId": "messagingListTargets", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13770,7 +14061,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 359, + "group": "messages", + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -13824,9 +14116,7 @@ "get": { "summary": "List providers", "operationId": "messagingListProviders", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -13844,7 +14134,8 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 329, + "group": "providers", + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -13919,7 +14210,8 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 328, + "group": "providers", + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -14034,7 +14326,8 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 341, + "group": "providers", + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -14147,7 +14440,8 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 327, + "group": "providers", + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -14238,7 +14532,8 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 340, + "group": "providers", + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -14327,7 +14622,8 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 319, + "group": "providers", + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -14454,7 +14750,8 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 332, + "group": "providers", + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -14579,7 +14876,8 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 322, + "group": "providers", + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -14682,7 +14980,8 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 335, + "group": "providers", + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -14783,7 +15082,8 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 320, + "group": "providers", + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -14898,7 +15198,8 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 333, + "group": "providers", + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -15011,7 +15312,8 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 321, + "group": "providers", + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -15170,7 +15472,8 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 334, + "group": "providers", + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -15326,7 +15629,8 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 323, + "group": "providers", + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -15429,7 +15733,8 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 336, + "group": "providers", + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -15530,7 +15835,8 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 324, + "group": "providers", + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -15633,7 +15939,8 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 337, + "group": "providers", + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -15734,7 +16041,8 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 325, + "group": "providers", + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -15837,7 +16145,8 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 338, + "group": "providers", + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -15938,7 +16247,8 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 326, + "group": "providers", + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -16041,7 +16351,8 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 339, + "group": "providers", + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -16122,9 +16433,7 @@ "get": { "summary": "Get provider", "operationId": "messagingGetProvider", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -16142,7 +16451,8 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 331, + "group": "providers", + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -16197,7 +16507,8 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 342, + "group": "providers", + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -16239,9 +16550,7 @@ "get": { "summary": "List provider logs", "operationId": "messagingListProviderLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -16259,7 +16568,8 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 330, + "group": "providers", + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -16313,9 +16623,7 @@ "get": { "summary": "List subscriber logs", "operationId": "messagingListSubscriberLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -16333,7 +16641,8 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 351, + "group": "subscribers", + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -16387,9 +16696,7 @@ "get": { "summary": "List topics", "operationId": "messagingListTopics", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -16407,7 +16714,8 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 344, + "group": "topics", + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -16480,7 +16788,8 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 343, + "group": "topics", + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -16550,9 +16859,7 @@ "get": { "summary": "Get topic", "operationId": "messagingGetTopic", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -16570,7 +16877,8 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 346, + "group": "topics", + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -16630,7 +16938,8 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 347, + "group": "topics", + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -16709,7 +17018,8 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 348, + "group": "topics", + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -16751,9 +17061,7 @@ "get": { "summary": "List topic logs", "operationId": "messagingListTopicLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -16771,7 +17079,8 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 345, + "group": "topics", + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -16825,9 +17134,7 @@ "get": { "summary": "List subscribers", "operationId": "messagingListSubscribers", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -16845,7 +17152,8 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 350, + "group": "subscribers", + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -16926,7 +17234,8 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 349, + "group": "subscribers", + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -16997,9 +17306,7 @@ "get": { "summary": "Get subscriber", "operationId": "messagingGetSubscriber", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17017,7 +17324,8 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 352, + "group": "subscribers", + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -17080,7 +17388,8 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 353, + "group": "subscribers", + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -17134,9 +17443,7 @@ "get": { "summary": "List sites", "operationId": "sitesList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17154,7 +17461,8 @@ }, "x-appwrite": { "method": "list", - "weight": 397, + "group": "sites", + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -17226,7 +17534,8 @@ }, "x-appwrite": { "method": "create", - "weight": 395, + "group": "sites", + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -17287,6 +17596,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -17472,9 +17782,7 @@ "get": { "summary": "List frameworks", "operationId": "sitesListFrameworks", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17492,7 +17800,8 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 400, + "group": "frameworks", + "weight": 407, "cookies": false, "type": "", "deprecated": false, @@ -17523,9 +17832,7 @@ "get": { "summary": "List specifications", "operationId": "sitesListSpecifications", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17543,7 +17850,8 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 423, + "group": "frameworks", + "weight": 430, "cookies": false, "type": "", "deprecated": false, @@ -17575,9 +17883,7 @@ "get": { "summary": "Get site", "operationId": "sitesGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -17595,7 +17901,8 @@ }, "x-appwrite": { "method": "get", - "weight": 396, + "group": "sites", + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -17654,7 +17961,8 @@ }, "x-appwrite": { "method": "update", - "weight": 398, + "group": "sites", + "weight": 405, "cookies": false, "type": "", "deprecated": false, @@ -17717,6 +18025,7 @@ "remix", "lynx", "flutter", + "react-native", "vite", "other" ], @@ -17913,7 +18222,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 399, + "group": "sites", + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -17974,7 +18284,8 @@ }, "x-appwrite": { "method": "updateSiteDeployment", - "weight": 406, + "group": "sites", + "weight": 413, "cookies": false, "type": "", "deprecated": false, @@ -18033,9 +18344,7 @@ "get": { "summary": "List deployments", "operationId": "sitesListDeployments", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18053,7 +18362,8 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 405, + "group": "deployments", + "weight": 412, "cookies": false, "type": "", "deprecated": false, @@ -18133,7 +18443,8 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 401, + "group": "deployments", + "weight": 408, "cookies": false, "type": "upload", "deprecated": false, @@ -18233,7 +18544,8 @@ }, "x-appwrite": { "method": "createDuplicateDeployment", - "weight": 409, + "group": "deployments", + "weight": 416, "cookies": false, "type": "", "deprecated": false, @@ -18312,7 +18624,8 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 402, + "group": "deployments", + "weight": 409, "cookies": false, "type": "", "deprecated": false, @@ -18418,7 +18731,8 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 403, + "group": "deployments", + "weight": 410, "cookies": false, "type": "", "deprecated": false, @@ -18497,9 +18811,7 @@ "get": { "summary": "Get deployment", "operationId": "sitesGetDeployment", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18517,7 +18829,8 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 404, + "group": "deployments", + "weight": 411, "cookies": false, "type": "", "deprecated": false, @@ -18579,7 +18892,8 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 407, + "group": "deployments", + "weight": 414, "cookies": false, "type": "", "deprecated": false, @@ -18626,11 +18940,9 @@ }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Download deployment", + "summary": "Get deployment download", "operationId": "sitesGetDeploymentDownload", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -18648,7 +18960,8 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 408, + "group": "deployments", + "weight": 415, "cookies": false, "type": "location", "deprecated": false, @@ -18734,7 +19047,8 @@ }, "x-appwrite": { "method": "updateDeploymentStatus", - "weight": 410, + "group": "deployments", + "weight": 417, "cookies": false, "type": "", "deprecated": false, @@ -18783,9 +19097,7 @@ "get": { "summary": "List logs", "operationId": "sitesListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18803,7 +19115,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 412, + "group": "logs", + "weight": 419, "cookies": false, "type": "", "deprecated": false, @@ -18856,9 +19169,7 @@ "get": { "summary": "Get log", "operationId": "sitesGetLog", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -18876,7 +19187,8 @@ }, "x-appwrite": { "method": "getLog", - "weight": 411, + "group": "logs", + "weight": 418, "cookies": false, "type": "", "deprecated": false, @@ -18940,7 +19252,8 @@ }, "x-appwrite": { "method": "deleteLog", - "weight": 413, + "group": "logs", + "weight": 420, "cookies": false, "type": "", "deprecated": false, @@ -18989,9 +19302,7 @@ "get": { "summary": "List variables", "operationId": "sitesListVariables", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19009,7 +19320,8 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 416, + "group": "variables", + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -19068,7 +19380,8 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 414, + "group": "variables", + "weight": 421, "cookies": false, "type": "", "deprecated": false, @@ -19140,9 +19453,7 @@ "get": { "summary": "Get variable", "operationId": "sitesGetVariable", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19160,7 +19471,8 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 415, + "group": "variables", + "weight": 422, "cookies": false, "type": "", "deprecated": false, @@ -19227,7 +19539,8 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 417, + "group": "variables", + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -19319,7 +19632,8 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 418, + "group": "variables", + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -19368,9 +19682,7 @@ "get": { "summary": "List buckets", "operationId": "storageListBuckets", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19388,7 +19700,8 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 204, + "group": "buckets", + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -19460,7 +19773,8 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 203, + "group": "buckets", + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -19579,9 +19893,7 @@ "get": { "summary": "Get bucket", "operationId": "storageGetBucket", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19599,7 +19911,8 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 205, + "group": "buckets", + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -19658,7 +19971,8 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 206, + "group": "buckets", + "weight": 208, "cookies": false, "type": "", "deprecated": false, @@ -19791,7 +20105,8 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 207, + "group": "buckets", + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -19832,9 +20147,7 @@ "get": { "summary": "List files", "operationId": "storageListFiles", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -19852,7 +20165,8 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 209, + "group": "files", + "weight": 211, "cookies": false, "type": "", "deprecated": false, @@ -19936,7 +20250,8 @@ }, "x-appwrite": { "method": "createFile", - "weight": 208, + "group": "files", + "weight": 210, "cookies": false, "type": "upload", "deprecated": false, @@ -20009,9 +20324,7 @@ "get": { "summary": "Get file", "operationId": "storageGetFile", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -20029,7 +20342,8 @@ }, "x-appwrite": { "method": "getFile", - "weight": 210, + "group": "files", + "weight": 212, "cookies": false, "type": "", "deprecated": false, @@ -20100,7 +20414,8 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 215, + "group": "files", + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -20190,7 +20505,8 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 216, + "group": "files", + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -20243,9 +20559,7 @@ "get": { "summary": "Get file for download", "operationId": "storageGetFileDownload", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -20263,7 +20577,8 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 212, + "group": "files", + "weight": 214, "cookies": false, "type": "location", "deprecated": false, @@ -20308,6 +20623,15 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -20316,9 +20640,7 @@ "get": { "summary": "Get file preview", "operationId": "storageGetFilePreview", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "image\/*" ], @@ -20336,7 +20658,8 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 211, + "group": "files", + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -20426,12 +20749,12 @@ }, { "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to 100.", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", "required": false, "type": "integer", "format": "int32", - "x-example": 0, - "default": 100, + "x-example": -1, + "default": -1, "in": "query" }, { @@ -20509,6 +20832,15 @@ "x-enum-keys": [], "default": "", "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -20517,9 +20849,7 @@ "get": { "summary": "Get file for view", "operationId": "storageGetFileView", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "*\/*" ], @@ -20537,7 +20867,8 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 213, + "group": "files", + "weight": 215, "cookies": false, "type": "location", "deprecated": false, @@ -20582,6 +20913,15 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -20590,9 +20930,7 @@ "get": { "summary": "List teams", "operationId": "teamsList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -20610,7 +20948,8 @@ }, "x-appwrite": { "method": "list", - "weight": 220, + "group": "teams", + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -20686,7 +21025,8 @@ }, "x-appwrite": { "method": "create", - "weight": 219, + "group": "teams", + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -20759,9 +21099,7 @@ "get": { "summary": "Get team", "operationId": "teamsGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -20779,7 +21117,8 @@ }, "x-appwrite": { "method": "get", - "weight": 221, + "group": "teams", + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -20842,7 +21181,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 223, + "group": "teams", + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -20918,7 +21258,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 225, + "group": "teams", + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -20963,9 +21304,7 @@ "get": { "summary": "List team memberships", "operationId": "teamsListMemberships", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -20983,7 +21322,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 227, + "group": "memberships", + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -21067,7 +21407,8 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 226, + "group": "memberships", + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -21163,9 +21504,7 @@ "get": { "summary": "Get team membership", "operationId": "teamsGetMembership", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21183,7 +21522,8 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 228, + "group": "memberships", + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -21254,7 +21594,8 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 229, + "group": "memberships", + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -21341,7 +21682,8 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 231, + "group": "memberships", + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -21414,7 +21756,8 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 230, + "group": "memberships", + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -21490,9 +21833,7 @@ "get": { "summary": "Get team preferences", "operationId": "teamsGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21510,7 +21851,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 222, + "group": "teams", + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -21571,7 +21913,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 224, + "group": "teams", + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -21632,9 +21975,7 @@ "get": { "summary": "List tokens", "operationId": "tokensList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21652,7 +21993,8 @@ }, "x-appwrite": { "method": "list", - "weight": 432, + "group": "files", + "weight": 438, "cookies": false, "type": "", "deprecated": false, @@ -21663,22 +22005,19 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21724,7 +22063,7 @@ "tags": [ "tokens" ], - "description": "Create a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "description": "Create a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "responses": { "201": { "description": "ResourceToken", @@ -21735,33 +22074,31 @@ }, "x-appwrite": { "method": "createFileToken", - "weight": 429, + "group": "files", + "weight": 436, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/create-file-token.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file or a bucket and manages permissions for those file(s). Token can be passed as a header or request get parameter.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file. Token can be passed as a header or request get parameter.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21793,15 +22130,6 @@ "default": null, "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": [], - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -21813,9 +22141,7 @@ "get": { "summary": "Get token", "operationId": "tokensGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -21833,7 +22159,8 @@ }, "x-appwrite": { "method": "get", - "weight": 430, + "group": "tokens", + "weight": 437, "cookies": false, "type": "", "deprecated": false, @@ -21844,22 +22171,19 @@ "rate-key": "url:{url},ip:{ip}", "scope": "tokens.read", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21885,7 +22209,7 @@ "tags": [ "tokens" ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { "200": { "description": "ResourceToken", @@ -21896,33 +22220,31 @@ }, "x-appwrite": { "method": "update", - "weight": 433, + "group": "tokens", + "weight": 439, "cookies": false, "type": "", "deprecated": false, "demo": "tokens\/update.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date or permissions.", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date.", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -21946,15 +22268,6 @@ "default": null, "x-example": null, "x-nullable": true - }, - "permissions": { - "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } } } } @@ -21979,7 +22292,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 434, + "group": "tokens", + "weight": 440, "cookies": false, "type": "", "deprecated": false, @@ -21990,22 +22304,19 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "tokens.write", "platforms": [ - "client", - "server", + "console", "server" ], "packaging": false, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -22020,78 +22331,11 @@ ] } }, - "\/tokens\/{tokenId}\/jwt": { - "get": { - "summary": "Get token as JWT", - "operationId": "tokensGetJWT", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tokens" - ], - "description": "Get a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "responses": { - "200": { - "description": "JWT", - "schema": { - "$ref": "#\/definitions\/jwt" - } - } - }, - "x-appwrite": { - "method": "getJWT", - "weight": 431, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "tokens\/get-j-w-t.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a JWT based token by its unique ID. You can use the JWT to authenticate on behalf of the user.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", - "platforms": [ - "client", - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "File token ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, "\/users": { "get": { "summary": "List users", "operationId": "usersList", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -22109,7 +22353,8 @@ }, "x-appwrite": { "method": "list", - "weight": 242, + "group": "users", + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -22181,7 +22426,8 @@ }, "x-appwrite": { "method": "create", - "weight": 233, + "group": "users", + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -22276,7 +22522,8 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 236, + "group": "users", + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -22367,7 +22614,8 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 234, + "group": "users", + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -22438,9 +22686,7 @@ "get": { "summary": "List identities", "operationId": "usersListIdentities", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -22458,7 +22704,8 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 250, + "group": "identities", + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -22527,7 +22774,8 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 273, + "group": "identities", + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -22588,7 +22836,8 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 235, + "group": "users", + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -22679,7 +22928,8 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 238, + "group": "users", + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -22770,7 +23020,8 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 239, + "group": "users", + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -22896,7 +23147,8 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 240, + "group": "users", + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -23008,7 +23260,8 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 237, + "group": "users", + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -23100,9 +23353,7 @@ "get": { "summary": "Get user", "operationId": "usersGet", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -23120,7 +23371,8 @@ }, "x-appwrite": { "method": "get", - "weight": 243, + "group": "users", + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -23174,7 +23426,8 @@ }, "x-appwrite": { "method": "delete", - "weight": 271, + "group": "users", + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -23235,7 +23488,8 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 256, + "group": "users", + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -23314,7 +23568,8 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 274, + "group": "sessions", + "weight": 276, "cookies": false, "type": "", "deprecated": false, @@ -23396,7 +23651,8 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 252, + "group": "users", + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -23458,9 +23714,7 @@ "get": { "summary": "List user logs", "operationId": "usersListLogs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -23478,7 +23732,8 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 248, + "group": "logs", + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -23531,9 +23786,7 @@ "get": { "summary": "List user memberships", "operationId": "usersListMemberships", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -23551,7 +23804,8 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 247, + "group": "memberships", + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -23633,7 +23887,8 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 261, + "group": "users", + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -23707,7 +23962,8 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 266, + "group": "mfa", + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -23761,9 +24017,7 @@ "get": { "summary": "List factors", "operationId": "usersListMfaFactors", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -23781,7 +24035,8 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 262, + "group": "mfa", + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -23822,9 +24077,7 @@ "get": { "summary": "Get MFA recovery codes", "operationId": "usersGetMfaRecoveryCodes", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -23842,7 +24095,8 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 263, + "group": "mfa", + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -23879,7 +24133,7 @@ ] }, "put": { - "summary": "Regenerate MFA recovery codes", + "summary": "Update MFA recovery codes (regenerate)", "operationId": "usersUpdateMfaRecoveryCodes", "consumes": [ "application\/json" @@ -23901,7 +24155,8 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 265, + "group": "mfa", + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -23960,7 +24215,8 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 264, + "group": "mfa", + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -24021,7 +24277,8 @@ }, "x-appwrite": { "method": "updateName", - "weight": 254, + "group": "users", + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -24100,7 +24357,8 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 255, + "group": "users", + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -24179,7 +24437,8 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 257, + "group": "users", + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -24238,9 +24497,7 @@ "get": { "summary": "Get user preferences", "operationId": "usersGetPrefs", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -24258,7 +24515,8 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 244, + "group": "users", + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -24317,7 +24575,8 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 259, + "group": "users", + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -24376,9 +24635,7 @@ "get": { "summary": "List user sessions", "operationId": "usersListSessions", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -24396,7 +24653,8 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 246, + "group": "sessions", + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -24455,7 +24713,8 @@ }, "x-appwrite": { "method": "createSession", - "weight": 267, + "group": "sessions", + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -24509,7 +24768,8 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 270, + "group": "sessions", + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -24565,7 +24825,8 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 269, + "group": "sessions", + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -24634,7 +24895,8 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 251, + "group": "users", + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -24693,9 +24955,7 @@ "get": { "summary": "List user targets", "operationId": "usersListTargets", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -24713,7 +24973,8 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 249, + "group": "targets", + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -24785,7 +25046,8 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 241, + "group": "targets", + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -24878,9 +25140,7 @@ "get": { "summary": "Get user target", "operationId": "usersGetTarget", - "consumes": [ - "application\/json" - ], + "consumes": [], "produces": [ "application\/json" ], @@ -24898,7 +25158,8 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 245, + "group": "targets", + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -24966,7 +25227,8 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 260, + "group": "targets", + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -25056,7 +25318,8 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 272, + "group": "targets", + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -25126,7 +25389,8 @@ }, "x-appwrite": { "method": "createToken", - "weight": 268, + "group": "sessions", + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -25208,7 +25472,8 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 258, + "group": "users", + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -25287,7 +25552,8 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 253, + "group": "users", + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -25346,90 +25612,71 @@ "tags": [ { "name": "account", - "description": "The Account service allows you to authenticate and manage a user account.", - "x-globalAttributes": [] + "description": "The Account service allows you to authenticate and manage a user account." }, { "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.", - "x-globalAttributes": [] + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." }, { "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents", - "x-globalAttributes": [ - "databaseId" - ] + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" }, { "name": "locale", - "description": "The Locale service allows you to customize your app based on your users' location.", - "x-globalAttributes": [] + "description": "The Locale service allows you to customize your app based on your users' location." }, { "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health.", - "x-globalAttributes": [] + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." }, { "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server.", - "x-globalAttributes": [] + "description": "The Project service allows you to manage all the projects in your Appwrite server." }, { "name": "storage", - "description": "The Storage service allows you to manage your project files.", - "x-globalAttributes": [] + "description": "The Storage service allows you to manage your project files." }, { "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources", - "x-globalAttributes": [] + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" }, { "name": "users", - "description": "The Users service allows you to manage your project users.", - "x-globalAttributes": [] + "description": "The Users service allows you to manage your project users." }, { "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications.", - "x-globalAttributes": [] + "description": "The Sites Service allows you view, create and manage your web applications." }, { "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions.", - "x-globalAttributes": [] + "description": "The Functions Service allows you view, create and manage your Cloud Functions." }, { "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration.", - "x-globalAttributes": [] + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." }, { "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.", - "x-globalAttributes": [] + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." }, { "name": "console", - "description": "The Console service allows you to interact with console relevant informations.", - "x-globalAttributes": [] + "description": "The Console service allows you to interact with console relevant informations." }, { "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project.", - "x-globalAttributes": [] + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." }, { "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).", - "x-globalAttributes": [] + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." } ], "definitions": { @@ -27200,6 +27447,15 @@ }, "x-example": [] }, + "lengths": { + "type": "array", + "description": "Index attributes length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, "orders": { "type": "array", "description": "Index orders.", @@ -27226,6 +27482,7 @@ "status", "error", "attributes", + "lengths", "$createdAt", "$updatedAt" ] @@ -28323,29 +28580,35 @@ "description": "Resource ID.", "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" }, - "resourceInternalId": { - "type": "string", - "description": "File ID.", - "x-example": "1:1" - }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "file" + "x-example": "files" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + }, + "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" } }, "required": [ "$id", "$createdAt", "resourceId", - "resourceInternalId", "resourceType", - "expire" + "expire", + "secret", + "accessedAt" ] }, "team": { diff --git a/app/config/specs/swagger2-latest-client.json b/app/config/specs/swagger2-latest-client.json index ffd7eaabe6d..35b2f8bce74 100644 --- a/app/config/specs/swagger2-latest-client.json +++ b/app/config/specs/swagger2-latest-client.json @@ -4605,6 +4605,11 @@ "methods": [ { "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, "parameters": [ "databaseId", "collectionId", @@ -4625,6 +4630,29 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." } ], "auth": { diff --git a/app/config/specs/swagger2-latest-console.json b/app/config/specs/swagger2-latest-console.json index 7bbc9391d37..749b23ddd54 100644 --- a/app/config/specs/swagger2-latest-console.json +++ b/app/config/specs/swagger2-latest-console.json @@ -8153,6 +8153,11 @@ "methods": [ { "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, "parameters": [ "databaseId", "collectionId", @@ -8173,6 +8178,29 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." } ], "auth": { diff --git a/app/config/specs/swagger2-latest-server.json b/app/config/specs/swagger2-latest-server.json index 554a8579a6d..5e535655dd3 100644 --- a/app/config/specs/swagger2-latest-server.json +++ b/app/config/specs/swagger2-latest-server.json @@ -7624,6 +7624,11 @@ "methods": [ { "name": "createDocument", + "auth": { + "Session": [], + "Key": [], + "JWT": [] + }, "parameters": [ "databaseId", "collectionId", @@ -7644,6 +7649,29 @@ } ], "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." + }, + { + "name": "createDocuments", + "auth": { + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console." } ], "auth": { diff --git a/app/controllers/api/databases.php b/app/controllers/api/databases.php index a72aaf66a38..2e847ae11c7 100644 --- a/app/controllers/api/databases.php +++ b/app/controllers/api/databases.php @@ -3201,25 +3201,25 @@ function updateAttribute( new Parameter('permissions', optional: true), ] ), - // new Method( - // namespace: 'databases', - // group: 'documents', - // name: 'createDocuments', - // description: '/docs/references/databases/create-documents.md', - // auth: [AuthType::KEY], - // responses: [ - // new SDKResponse( - // code: Response::STATUS_CODE_CREATED, - // model: Response::MODEL_DOCUMENT_LIST, - // ) - // ], - // contentType: ContentType::JSON, - // parameters: [ - // new Parameter('databaseId', optional: false), - // new Parameter('collectionId', optional: false), - // new Parameter('documents', optional: false), - // ] - // ) + new Method( + namespace: 'databases', + group: 'documents', + name: 'createDocuments', + description: '/docs/references/databases/create-documents.md', + auth: [AuthType::KEY], + responses: [ + new SDKResponse( + code: Response::STATUS_CODE_CREATED, + model: Response::MODEL_DOCUMENT_LIST, + ) + ], + contentType: ContentType::JSON, + parameters: [ + new Parameter('databaseId', optional: false), + new Parameter('collectionId', optional: false), + new Parameter('documents', optional: false), + ] + ) ] ) ->param('databaseId', '', new UID(), 'Database ID.') diff --git a/composer.lock b/composer.lock index c68d6bf4d78..98735116979 100644 --- a/composer.lock +++ b/composer.lock @@ -3499,16 +3499,16 @@ }, { "name": "utopia-php/database", - "version": "0.69.2", + "version": "0.69.4", "source": { "type": "git", "url": "https://github.com/utopia-php/database.git", - "reference": "60591ab073bb80bb9843338754b679bb8169e4ed" + "reference": "31f913a9c5c363e6427e69a0b8bbb9b8d901e061" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/utopia-php/database/zipball/60591ab073bb80bb9843338754b679bb8169e4ed", - "reference": "60591ab073bb80bb9843338754b679bb8169e4ed", + "url": "https://api.github.com/repos/utopia-php/database/zipball/31f913a9c5c363e6427e69a0b8bbb9b8d901e061", + "reference": "31f913a9c5c363e6427e69a0b8bbb9b8d901e061", "shasum": "" }, "require": { @@ -3549,9 +3549,9 @@ ], "support": { "issues": "https://github.com/utopia-php/database/issues", - "source": "https://github.com/utopia-php/database/tree/0.69.2" + "source": "https://github.com/utopia-php/database/tree/0.69.4" }, - "time": "2025-05-14T07:51:44+00:00" + "time": "2025-05-16T13:51:43+00:00" }, { "name": "utopia-php/detector", @@ -4814,16 +4814,16 @@ "packages-dev": [ { "name": "appwrite/sdk-generator", - "version": "0.40.16", + "version": "0.40.17", "source": { "type": "git", "url": "https://github.com/appwrite/sdk-generator.git", - "reference": "f1f506da74033f0cb5a11e3dffcfd1ee8daf237d" + "reference": "7e333c1003bfd4763e4d6f3a0a799fde5e7bc4de" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/appwrite/sdk-generator/zipball/f1f506da74033f0cb5a11e3dffcfd1ee8daf237d", - "reference": "f1f506da74033f0cb5a11e3dffcfd1ee8daf237d", + "url": "https://api.github.com/repos/appwrite/sdk-generator/zipball/7e333c1003bfd4763e4d6f3a0a799fde5e7bc4de", + "reference": "7e333c1003bfd4763e4d6f3a0a799fde5e7bc4de", "shasum": "" }, "require": { @@ -4859,9 +4859,9 @@ "description": "Appwrite PHP library for generating API SDKs for multiple programming languages and platforms", "support": { "issues": "https://github.com/appwrite/sdk-generator/issues", - "source": "https://github.com/appwrite/sdk-generator/tree/0.40.16" + "source": "https://github.com/appwrite/sdk-generator/tree/0.40.17" }, - "time": "2025-05-09T12:06:09+00:00" + "time": "2025-05-16T15:10:54+00:00" }, { "name": "doctrine/annotations", @@ -8240,7 +8240,7 @@ ], "aliases": [], "minimum-stability": "stable", - "stability-flags": [], + "stability-flags": {}, "prefer-stable": false, "prefer-lowest": false, "platform": { @@ -8264,5 +8264,5 @@ "platform-overrides": { "php": "8.3" }, - "plugin-api-version": "2.3.0" + "plugin-api-version": "2.6.0" } diff --git a/src/Appwrite/SDK/Specification/Format/OpenAPI3.php b/src/Appwrite/SDK/Specification/Format/OpenAPI3.php index 358b32c73cf..f486a61ce5b 100644 --- a/src/Appwrite/SDK/Specification/Format/OpenAPI3.php +++ b/src/Appwrite/SDK/Specification/Format/OpenAPI3.php @@ -178,6 +178,7 @@ public function parse(): array $desc = $method->getDescriptionFilePath(); $additionalMethod = [ 'name' => $method->getMethodName(), + 'auth' => \array_merge(...\array_map(fn ($auth) => [$auth->value => []], $method->getAuth())), 'parameters' => [], 'required' => [], 'responses' => [], diff --git a/src/Appwrite/SDK/Specification/Format/Swagger2.php b/src/Appwrite/SDK/Specification/Format/Swagger2.php index b57ea11ce49..948798ef0be 100644 --- a/src/Appwrite/SDK/Specification/Format/Swagger2.php +++ b/src/Appwrite/SDK/Specification/Format/Swagger2.php @@ -184,6 +184,7 @@ public function parse(): array $additionalMethod = [ 'name' => $method->getMethodName(), + 'auth' => \array_merge(...\array_map(fn ($auth) => [$auth->value => []], $method->getAuth())), 'parameters' => [], 'required' => [], 'responses' => [], @@ -286,13 +287,13 @@ public function parse(): array $securities = ['Project' => []]; foreach ($sdk->getAuth() as $security) { - /** @var \Appwrite\SDK\AuthType $security */ - if (array_key_exists($security->value, $this->keys)) { + /** @var AuthType $security */ + if (\array_key_exists($security->value, $this->keys)) { $securities[$security->value] = []; } } - $temp['x-appwrite']['auth'] = array_slice($securities, 0, $this->authCount); + $temp['x-appwrite']['auth'] = \array_slice($securities, 0, $this->authCount); $temp['security'][] = $securities; }